#metadata (unspecified)

Download OpenAPI specification:Download

Fast Healthcare Interoperability Resources (FHIR, pronounced "Fire") defines a set of "Resources" that represent granular clinical concepts. The resources can be managed in isolation, or aggregated into complex documents. Technically, FHIR is designed for the web; the resources are based on simple XML or JSON structures, with an http-based RESTful protocol where each resource has predictable URL. Where possible, open internet standards are used for data representation.

Account

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
fhir_comments required	Array of objects
id required	string non-empty
text required	object

Responses

200

Success

post /Account

https://dev-pineapple-fhir.azurehealthcareapis.com/Account

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"fhir_comments":
[
- { }
],
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
balance	integer How much is in account?
identifier	string Account number
name	string Human-readable label
owner	string Who is responsible?
patient	string What is account tied to?
period	string <date> Transaction window
status	string active \| inactive \| entered-in-error
subject	string What is account tied to?
type	string E.g. patient, expense, depreciation
_format	string

Responses

200

Success

get /Account

https://dev-pineapple-fhir.azurehealthcareapis.com/Account

<no summary>

path Parameters

required

string

Responses

200

Success

get /Account/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Account/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
fhir_comments required	Array of objects
id required	string non-empty
text required	object

Responses

200

Success

put /Account/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Account/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"fhir_comments":
[
- { }
],
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Account/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Account/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Account/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Account/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Account/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Account/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Account/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Account/{id}/_history/{vid}

ActivityDefinition

<no summary>

Request Body schema: application/json

any (ActivityDefinition)

Responses

200

Success

post /ActivityDefinition

https://dev-pineapple-fhir.azurehealthcareapis.com/ActivityDefinition

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
composed-of	string What resource is being referenced
date	string <date> The activity definition publication date
depends-on	string What resource is being referenced
derived-from	string What resource is being referenced
description	string The description of the activity definition
effective	string <date> The time during which the activity definition is intended to be in use
identifier	string External identifier for the activity definition
jurisdiction	string Intended jurisdiction for the activity definition
name	string Computationally friendly name of the activity definition
predecessor	string What resource is being referenced
publisher	string Name of the publisher of the activity definition
status	string The current status of the activity definition
successor	string What resource is being referenced
title	string The human-friendly name of the activity definition
topic	string Topics associated with the module
url	string The uri that identifies the activity definition
version	string The business version of the activity definition
_format	string

Responses

200

Success

get /ActivityDefinition

https://dev-pineapple-fhir.azurehealthcareapis.com/ActivityDefinition

<no summary>

path Parameters

required

string

Responses

200

Success

get /ActivityDefinition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ActivityDefinition/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

any (ActivityDefinition)

Responses

200

Success

put /ActivityDefinition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ActivityDefinition/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

path Parameters

required

string

Responses

200

Success

delete /ActivityDefinition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ActivityDefinition/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /ActivityDefinition/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ActivityDefinition/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /ActivityDefinition/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ActivityDefinition/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /ActivityDefinition/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/ActivityDefinition/{id}/_history/{vid}

AdverseEvent

<no summary>

Request Body schema: application/json

any (AdverseEvent)

Responses

200

Success

post /AdverseEvent

https://dev-pineapple-fhir.azurehealthcareapis.com/AdverseEvent

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
category	string "AE \| PAE An adverse event is an event that caused harm to a patient, an adverse reaction is a something that is a subject-specific event that is a result of an exposure to a medication, food, device or environmental substance, a potential adverse event is something that occurred and that could have caused harm to a patient but did not
date	string <date> When the event occurred
location	string Location where adverse event occurred
reaction	string Adverse Reaction Events linked to exposure to substance
recorder	string Who recorded the adverse event
seriousness	string Mild \| Moderate \| Severe
study	string AdverseEvent.study
subject	string Subject or group impacted by event
substance	string Refers to the specific entity that caused the adverse event
type	string actual \| potential
_format	string

Responses

200

Success

get /AdverseEvent

https://dev-pineapple-fhir.azurehealthcareapis.com/AdverseEvent

<no summary>

path Parameters

required

string

Responses

200

Success

get /AdverseEvent/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/AdverseEvent/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

any (AdverseEvent)

Responses

200

Success

put /AdverseEvent/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/AdverseEvent/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

path Parameters

required

string

Responses

200

Success

delete /AdverseEvent/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/AdverseEvent/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /AdverseEvent/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/AdverseEvent/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /AdverseEvent/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/AdverseEvent/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /AdverseEvent/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/AdverseEvent/{id}/_history/{vid}

AllergyIntolerance

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
status required	string non-empty
_status required	object
type required	string non-empty
_type required	object
category required	string non-empty
_category required	object
criticality required	string non-empty
_criticality required	object
substance required	object
patient required	object
recordedDate required	string non-empty
_recordedDate required	object
recorder required	object
reporter required	object
onset required	string non-empty
_onset required	object
lastOccurence required	string non-empty
_lastOccurence required	object
note required	Array of objects non-empty
reaction required	Array of objects non-empty

Responses

200

Success

post /AllergyIntolerance

https://dev-pineapple-fhir.azurehealthcareapis.com/AllergyIntolerance

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "fhir_comments":
  [
  - { }
  ],
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"status": "string",
"_status":
{
- "fhir_comments":
  [
  - { }
  ]
},
"type": "string",
"_type":
{
- "fhir_comments":
  [
  - { }
  ]
},
"category": "string",
"_category":
{
- "fhir_comments":
  [
  - { }
  ]
},
"criticality": "string",
"_criticality":
{
- "fhir_comments":
  [
  - { }
  ]
},
"substance":
{
- "fhir_comments":
  [
  - { }
  ],
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"patient":
{
- "fhir_comments":
  [
  - { }
  ],
- "reference": "string"
},
"recordedDate": "string",
"_recordedDate":
{
- "fhir_comments":
  [
  - { }
  ]
},
"recorder":
{
- "fhir_comments":
  [
  - { }
  ],
- "reference": "string"
},
"reporter":
{
- "fhir_comments":
  [
  - { }
  ],
- "reference": "string"
},
"onset": "string",
"_onset":
{
- "fhir_comments":
  [
  - { }
  ]
},
"lastOccurence": "string",
"_lastOccurence":
{
- "fhir_comments":
  [
  - { }
  ]
},
"note":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "text": "string"
  }
],
"reaction":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "substance":
    {
    "fhir_comments":
    [
    { }
    ],
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    },
  - "certainty": "string",
  - "manifestation":
    [
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    }
    ],
  - "description": "string",
  - "onset": "string",
  - "severity": "string",
  - "exposureRoute":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    }
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
asserter	string Source of the information about the allergy
category	string food \| medication \| environment \| biologic
clinical-status	string active \| inactive \| resolved
code	string Code that identifies the allergy or intolerance
criticality	string low \| high \| unable-to-assess
date	string <date> Date record was believed accurate
identifier	string External ids for this item
last-date	string <date> Date(/time) of last known occurrence of a reaction
manifestation	string Clinical symptoms/signs associated with the Event
onset	string <date> Date(/time) when manifestations showed
patient	string Who the sensitivity is for
recorder	string Who recorded the sensitivity
route	string How the subject was exposed to the substance
severity	string mild \| moderate \| severe (of event as a whole)
type	string allergy \| intolerance - Underlying mechanism (if known)
verification-status	string unconfirmed \| confirmed \| refuted \| entered-in-error
_format	string

Responses

200

Success

get /AllergyIntolerance

https://dev-pineapple-fhir.azurehealthcareapis.com/AllergyIntolerance

<no summary>

path Parameters

required

string

Responses

200

Success

get /AllergyIntolerance/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/AllergyIntolerance/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
status required	string non-empty
_status required	object
type required	string non-empty
_type required	object
category required	string non-empty
_category required	object
criticality required	string non-empty
_criticality required	object
substance required	object
patient required	object
recordedDate required	string non-empty
_recordedDate required	object
recorder required	object
reporter required	object
onset required	string non-empty
_onset required	object
lastOccurence required	string non-empty
_lastOccurence required	object
note required	Array of objects non-empty
reaction required	Array of objects non-empty

Responses

200

Success

put /AllergyIntolerance/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/AllergyIntolerance/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "fhir_comments":
  [
  - { }
  ],
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"status": "string",
"_status":
{
- "fhir_comments":
  [
  - { }
  ]
},
"type": "string",
"_type":
{
- "fhir_comments":
  [
  - { }
  ]
},
"category": "string",
"_category":
{
- "fhir_comments":
  [
  - { }
  ]
},
"criticality": "string",
"_criticality":
{
- "fhir_comments":
  [
  - { }
  ]
},
"substance":
{
- "fhir_comments":
  [
  - { }
  ],
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"patient":
{
- "fhir_comments":
  [
  - { }
  ],
- "reference": "string"
},
"recordedDate": "string",
"_recordedDate":
{
- "fhir_comments":
  [
  - { }
  ]
},
"recorder":
{
- "fhir_comments":
  [
  - { }
  ],
- "reference": "string"
},
"reporter":
{
- "fhir_comments":
  [
  - { }
  ],
- "reference": "string"
},
"onset": "string",
"_onset":
{
- "fhir_comments":
  [
  - { }
  ]
},
"lastOccurence": "string",
"_lastOccurence":
{
- "fhir_comments":
  [
  - { }
  ]
},
"note":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "text": "string"
  }
],
"reaction":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "substance":
    {
    "fhir_comments":
    [
    { }
    ],
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    },
  - "certainty": "string",
  - "manifestation":
    [
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    }
    ],
  - "description": "string",
  - "onset": "string",
  - "severity": "string",
  - "exposureRoute":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    }
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /AllergyIntolerance/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/AllergyIntolerance/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /AllergyIntolerance/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/AllergyIntolerance/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /AllergyIntolerance/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/AllergyIntolerance/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /AllergyIntolerance/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/AllergyIntolerance/{id}/_history/{vid}

Appointment

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
status required	string non-empty
serviceCategory required	object
serviceType required	Array of objects non-empty
specialty required	Array of objects non-empty
appointmentType required	object
priority required	number
description required	string non-empty
start required	string non-empty
end required	string non-empty
created required	string non-empty
comment required	string non-empty
participant required	Array of objects non-empty

Responses

200

Success

post /Appointment

https://dev-pineapple-fhir.azurehealthcareapis.com/Appointment

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"status": "string",
"serviceCategory":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"serviceType":
[
- {
  - "coding":
    [
    {
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"specialty":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"appointmentType":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"priority": 0,
"description": "string",
"start": "string",
"end": "string",
"created": "string",
"comment": "string",
"participant":
[
- {
  - "type":
    [
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
    }
    ],
  - "actor":
    {
    "reference": "string",
    "display": "string"
    },
  - "required": "string",
  - "status": "string"
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
actor	string Any one of the individuals participating in the appointment
appointment-type	string The style of appointment or patient that has been booked in the slot (not service type)
date	string <date> Appointment date/time.
identifier	string An Identifier of the Appointment
incomingreferral	string The ReferralRequest provided as information to allocate to the Encounter
location	string This location is listed in the participants of the appointment
part-status	string The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests.
patient	string One of the individuals of the appointment is this patient
practitioner	string One of the individuals of the appointment is this practitioner
service-type	string The specific service that is to be performed during this appointment
status	string The overall status of the appointment
_format	string

Responses

200

Success

get /Appointment

https://dev-pineapple-fhir.azurehealthcareapis.com/Appointment

<no summary>

path Parameters

required

string

Responses

200

Success

get /Appointment/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Appointment/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
status required	string non-empty
serviceCategory required	object
serviceType required	Array of objects non-empty
specialty required	Array of objects non-empty
appointmentType required	object
priority required	number
description required	string non-empty
start required	string non-empty
end required	string non-empty
created required	string non-empty
comment required	string non-empty
participant required	Array of objects non-empty

Responses

200

Success

put /Appointment/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Appointment/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"status": "string",
"serviceCategory":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"serviceType":
[
- {
  - "coding":
    [
    {
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"specialty":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"appointmentType":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"priority": 0,
"description": "string",
"start": "string",
"end": "string",
"created": "string",
"comment": "string",
"participant":
[
- {
  - "type":
    [
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
    }
    ],
  - "actor":
    {
    "reference": "string",
    "display": "string"
    },
  - "required": "string",
  - "status": "string"
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Appointment/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Appointment/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Appointment/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Appointment/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Appointment/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Appointment/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Appointment/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Appointment/{id}/_history/{vid}

AppointmentResponse

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
appointment required	object
actor required	object
participantStatus required	string non-empty

Responses

200

Success

post /AppointmentResponse

https://dev-pineapple-fhir.azurehealthcareapis.com/AppointmentResponse

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"appointment":
{
- "reference": "string",
- "display": "string"
},
"actor":
{
- "reference": "string",
- "display": "string"
},
"participantStatus": "string"

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
actor	string The Person, Location/HealthcareService or Device that this appointment response replies for
appointment	string The appointment that the response is attached to
identifier	string An Identifier in this appointment response
location	string This Response is for this Location
part-status	string The participants acceptance status for this appointment
patient	string This Response is for this Patient
practitioner	string This Response is for this Practitioner
_format	string

Responses

200

Success

get /AppointmentResponse

https://dev-pineapple-fhir.azurehealthcareapis.com/AppointmentResponse

<no summary>

path Parameters

required

string

Responses

200

Success

get /AppointmentResponse/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/AppointmentResponse/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
appointment required	object
actor required	object
participantStatus required	string non-empty

Responses

200

Success

put /AppointmentResponse/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/AppointmentResponse/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"appointment":
{
- "reference": "string",
- "display": "string"
},
"actor":
{
- "reference": "string",
- "display": "string"
},
"participantStatus": "string"

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /AppointmentResponse/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/AppointmentResponse/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /AppointmentResponse/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/AppointmentResponse/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /AppointmentResponse/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/AppointmentResponse/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /AppointmentResponse/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/AppointmentResponse/{id}/_history/{vid}

AuditEvent

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
type required	object
subtype required	Array of objects non-empty
action required	string non-empty
recorded required	string non-empty
outcome required	string non-empty
agent required	Array of objects non-empty
source required	object
entity required	Array of objects non-empty

Responses

200

Success

post /AuditEvent

https://dev-pineapple-fhir.azurehealthcareapis.com/AuditEvent

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"type":
{
- "system": "string",
- "code": "string",
- "display": "string"
},
"subtype":
[
- {
  - "system": "string",
  - "code": "string",
  - "display": "string"
  }
],
"action": "string",
"recorded": "string",
"outcome": "string",
"agent":
[
- {
  - "role":
    [
    {
    "text": "string"
    }
    ],
  - "userId":
    {
    "value": "string"
    },
  - "requestor": true,
  - "network":
    {
    "address": "string",
    "type": "string"
    }
  }
],
"source":
{
- "site": "string",
- "identifier":
  {
  - "value": "string"
  },
- "type":
  [
  - {
    "system": "string",
    "code": "string"
    }
  ]
},
"entity":
[
- {
  - "identifier":
    {
    "type":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ],
    "text": "string"
    },
    "value": "string"
    },
  - "type":
    {
    "system": "string",
    "code": "string",
    "display": "string"
    },
  - "role":
    {
    "system": "string",
    "code": "string",
    "display": "string"
    },
  - "lifecycle":
    {
    "system": "string",
    "code": "string",
    "display": "string"
    },
  - "name": "string"
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
action	string Type of action performed during the event
address	string Identifier for the network access point of the user device
agent-name	string Human-meaningful name for the agent
agent	string Direct reference to resource
agent-role	string Agent role in the event
altid	string Alternative User id e.g. authentication
date	string <date> Time when the event occurred on source
entity-id	string Specific instance of object
entity-name	string Descriptor for entity
entity	string Specific instance of resource
entity-role	string What role the entity played
entity-type	string Type of entity involved
outcome	string Whether the event succeeded or failed
patient	string Direct reference to resource
policy	string Policy that authorized event
site	string Logical source location within the enterprise
source	string The identity of source detecting the event
subtype	string More specific type/id for the event
type	string Type/identifier of event
user	string Unique identifier for the user
_format	string

Responses

200

Success

get /AuditEvent

https://dev-pineapple-fhir.azurehealthcareapis.com/AuditEvent

<no summary>

path Parameters

required

string

Responses

200

Success

get /AuditEvent/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/AuditEvent/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
type required	object
subtype required	Array of objects non-empty
action required	string non-empty
recorded required	string non-empty
outcome required	string non-empty
agent required	Array of objects non-empty
source required	object
entity required	Array of objects non-empty

Responses

200

Success

put /AuditEvent/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/AuditEvent/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"type":
{
- "system": "string",
- "code": "string",
- "display": "string"
},
"subtype":
[
- {
  - "system": "string",
  - "code": "string",
  - "display": "string"
  }
],
"action": "string",
"recorded": "string",
"outcome": "string",
"agent":
[
- {
  - "role":
    [
    {
    "text": "string"
    }
    ],
  - "userId":
    {
    "value": "string"
    },
  - "requestor": true,
  - "network":
    {
    "address": "string",
    "type": "string"
    }
  }
],
"source":
{
- "site": "string",
- "identifier":
  {
  - "value": "string"
  },
- "type":
  [
  - {
    "system": "string",
    "code": "string"
    }
  ]
},
"entity":
[
- {
  - "identifier":
    {
    "type":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ],
    "text": "string"
    },
    "value": "string"
    },
  - "type":
    {
    "system": "string",
    "code": "string",
    "display": "string"
    },
  - "role":
    {
    "system": "string",
    "code": "string",
    "display": "string"
    },
  - "lifecycle":
    {
    "system": "string",
    "code": "string",
    "display": "string"
    },
  - "name": "string"
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /AuditEvent/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/AuditEvent/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /AuditEvent/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/AuditEvent/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /AuditEvent/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/AuditEvent/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /AuditEvent/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/AuditEvent/{id}/_history/{vid}

Basic

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
extension required	Array of objects non-empty
modifierExtension required	Array of objects non-empty
code required	object
subject required	object
created required	string non-empty
author required	object

Responses

200

Success

post /Basic

https://dev-pineapple-fhir.azurehealthcareapis.com/Basic

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"extension":
[
- {
  - "url": "string",
  - "valueReference":
    {
    "reference": "string",
    "display": "string"
    }
  }
],
"modifierExtension":
[
- {
  - "url": "string",
  - "valueCodeableConcept":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    }
  }
],
"code":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string"
    }
  ]
},
"subject":
{
- "reference": "string",
- "display": "string"
},
"created": "string",
"author":
{
- "reference": "string"
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
author	string Who created
code	string Kind of Resource
created	string <date> When created
identifier	string Business identifier
patient	string Identifies the focus of this resource
subject	string Identifies the focus of this resource
_format	string

Responses

200

Success

get /Basic

https://dev-pineapple-fhir.azurehealthcareapis.com/Basic

<no summary>

path Parameters

required

string

Responses

200

Success

get /Basic/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Basic/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
extension required	Array of objects non-empty
modifierExtension required	Array of objects non-empty
code required	object
subject required	object
created required	string non-empty
author required	object

Responses

200

Success

put /Basic/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Basic/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"extension":
[
- {
  - "url": "string",
  - "valueReference":
    {
    "reference": "string",
    "display": "string"
    }
  }
],
"modifierExtension":
[
- {
  - "url": "string",
  - "valueCodeableConcept":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    }
  }
],
"code":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string"
    }
  ]
},
"subject":
{
- "reference": "string",
- "display": "string"
},
"created": "string",
"author":
{
- "reference": "string"
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Basic/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Basic/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Basic/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Basic/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Basic/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Basic/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Basic/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Basic/{id}/_history/{vid}

Binary

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
contentType required	string non-empty
content required	string non-empty

Responses

200

Success

post /Binary

https://dev-pineapple-fhir.azurehealthcareapis.com/Binary

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"contentType": "string",
"content": "string"

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
contenttype	string MimeType of the binary content
_format	string

Responses

200

Success

get /Binary

https://dev-pineapple-fhir.azurehealthcareapis.com/Binary

<no summary>

path Parameters

required

string

Responses

200

Success

get /Binary/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Binary/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
contentType required	string non-empty
content required	string non-empty

Responses

200

Success

put /Binary/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Binary/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"contentType": "string",
"content": "string"

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Binary/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Binary/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Binary/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Binary/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Binary/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Binary/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Binary/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Binary/{id}/_history/{vid}

BodySite

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
patient required	object
identifier required	Array of objects non-empty
code required	object
modifier required	Array of objects non-empty
description required	string non-empty
image required	Array of objects non-empty

Responses

200

Success

post /BodySite

https://dev-pineapple-fhir.azurehealthcareapis.com/BodySite

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "fhir_comments":
  [
  - { }
  ],
- "status": "string",
- "div": "string"
},
"patient":
{
- "reference": "string"
},
"identifier":
[
- {
  - "use": "string",
  - "system": "string",
  - "value": "string"
  }
],
"code":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ],
- "text": "string"
},
"modifier":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ],
  - "text": "string"
  }
],
"description": "string",
"image":
[
- {
  - "contentType": "string",
  - "data": "string",
  - "title": "string"
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
code	string Named anatomical location
identifier	string Identifier for this instance of the anatomical location
patient	string Patient to whom bodysite belongs
_format	string

Responses

200

Success

get /BodySite

https://dev-pineapple-fhir.azurehealthcareapis.com/BodySite

<no summary>

path Parameters

required

string

Responses

200

Success

get /BodySite/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/BodySite/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
patient required	object
identifier required	Array of objects non-empty
code required	object
modifier required	Array of objects non-empty
description required	string non-empty
image required	Array of objects non-empty

Responses

200

Success

put /BodySite/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/BodySite/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "fhir_comments":
  [
  - { }
  ],
- "status": "string",
- "div": "string"
},
"patient":
{
- "reference": "string"
},
"identifier":
[
- {
  - "use": "string",
  - "system": "string",
  - "value": "string"
  }
],
"code":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ],
- "text": "string"
},
"modifier":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ],
  - "text": "string"
  }
],
"description": "string",
"image":
[
- {
  - "contentType": "string",
  - "data": "string",
  - "title": "string"
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /BodySite/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/BodySite/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /BodySite/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/BodySite/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /BodySite/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/BodySite/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /BodySite/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/BodySite/{id}/_history/{vid}

Bundle

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
meta required	object
type required	string non-empty
total required	number
_total required	object
link required	Array of objects non-empty
entry required	Array of objects non-empty

Responses

200

Success

post /Bundle

https://dev-pineapple-fhir.azurehealthcareapis.com/Bundle

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"meta":
{
- "fhir_comments":
  [
  - { }
  ],
- "lastUpdated": "string"
},
"type": "string",
"total": 0,
"_total":
{
- "fhir_comments":
  [
  - { }
  ]
},
"link":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "relation": "string",
  - "url": "string"
  }
],
"entry":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "fullUrl": "string",
  - "resource":
    {
    "resourceType": "string",
    "id": "string",
    "text":
    {
    "fhir_comments":
    [
    { }
    ],
    "status": "string",
    "div": "string"
    },
    "medicationReference":
    {
    "reference": "string"
    },
    "patient":
    {
    "reference": "string"
    }
    },
  - "search":
    {
    "fhir_comments":
    [
    { }
    ],
    "mode": "string",
    "_mode":
    {
    "fhir_comments":
    [
    { }
    ]
    },
    "score": 0,
    "_score":
    {
    "fhir_comments":
    [
    { }
    ]
    }
    }
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
composition	string "The first resource in the bundle, if the bundle type is "document" - this is a composition, and this parameter provides access to searches its contents"
identifier	string Persistent identifier for the bundle
message	string "The first resource in the bundle, if the bundle type is "message" - this is a message header, and this parameter provides access to search its contents"
type	string document \| message \| transaction \| transaction-response \| batch \| batch-response \| history \| searchset \| collection
_format	string

Responses

200

Success

get /Bundle

https://dev-pineapple-fhir.azurehealthcareapis.com/Bundle

<no summary>

path Parameters

required

string

Responses

200

Success

get /Bundle/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Bundle/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
meta required	object
type required	string non-empty
total required	number
_total required	object
link required	Array of objects non-empty
entry required	Array of objects non-empty

Responses

200

Success

put /Bundle/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Bundle/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"meta":
{
- "fhir_comments":
  [
  - { }
  ],
- "lastUpdated": "string"
},
"type": "string",
"total": 0,
"_total":
{
- "fhir_comments":
  [
  - { }
  ]
},
"link":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "relation": "string",
  - "url": "string"
  }
],
"entry":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "fullUrl": "string",
  - "resource":
    {
    "resourceType": "string",
    "id": "string",
    "text":
    {
    "fhir_comments":
    [
    { }
    ],
    "status": "string",
    "div": "string"
    },
    "medicationReference":
    {
    "reference": "string"
    },
    "patient":
    {
    "reference": "string"
    }
    },
  - "search":
    {
    "fhir_comments":
    [
    { }
    ],
    "mode": "string",
    "_mode":
    {
    "fhir_comments":
    [
    { }
    ]
    },
    "score": 0,
    "_score":
    {
    "fhir_comments":
    [
    { }
    ]
    }
    }
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Bundle/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Bundle/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Bundle/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Bundle/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Bundle/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Bundle/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Bundle/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Bundle/{id}/_history/{vid}

CapabilityStatement

<no summary>

Request Body schema: application/json

any (CapabilityStatement)

Responses

200

Success

post /CapabilityStatement

https://dev-pineapple-fhir.azurehealthcareapis.com/CapabilityStatement

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
date	string <date> The capability statement publication date
description	string The description of the capability statement
event	string Event code in a capability statement
fhirversion	string The version of FHIR
format	string formats supported (xml \| json \| ttl \| mime type)
guide	string Implementation guides supported
jurisdiction	string Intended jurisdiction for the capability statement
mode	string Mode - restful (server/client) or messaging (sender/receiver)
name	string Computationally friendly name of the capability statement
publisher	string Name of the publisher of the capability statement
resource-profile	string A profile id invoked in a capability statement
resource	string Name of a resource mentioned in a capability statement
security-service	string OAuth \| SMART-on-FHIR \| NTLM \| Basic \| Kerberos \| Certificates
software	string Part of a the name of a software application
status	string The current status of the capability statement
supported-profile	string Profiles for use cases supported
title	string The human-friendly name of the capability statement
url	string The uri that identifies the capability statement
version	string The business version of the capability statement
_format	string

Responses

200

Success

get /CapabilityStatement

https://dev-pineapple-fhir.azurehealthcareapis.com/CapabilityStatement

<no summary>

path Parameters

required

string

Responses

200

Success

get /CapabilityStatement/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/CapabilityStatement/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

any (CapabilityStatement)

Responses

200

Success

put /CapabilityStatement/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/CapabilityStatement/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

path Parameters

required

string

Responses

200

Success

delete /CapabilityStatement/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/CapabilityStatement/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /CapabilityStatement/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/CapabilityStatement/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /CapabilityStatement/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/CapabilityStatement/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /CapabilityStatement/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/CapabilityStatement/{id}/_history/{vid}

CarePlan

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
contained required	Array of objects non-empty
subject required	object
status required	string non-empty
period required	object
addresses required	Array of objects non-empty
participant required	Array of objects non-empty
goal required	Array of objects non-empty
activity required	Array of objects non-empty

Responses

200

Success

post /CarePlan

https://dev-pineapple-fhir.azurehealthcareapis.com/CarePlan

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"contained":
[
- {
  - "resourceType": "string",
  - "id": "string",
  - "extension":
    [
    {
    "extension":
    [
    {
    "url": "string",
    "valueCodeableConcept":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    }
    }
    ],
    "url": "string"
    }
    ],
  - "subject":
    {
    "reference": "string",
    "display": "string"
    },
  - "description": "string",
  - "status": "string"
  }
],
"subject":
{
- "reference": "string",
- "display": "string"
},
"status": "string",
"period":
{
- "end": "string"
},
"addresses":
[
- {
  - "reference": "string",
  - "display": "string"
  }
],
"participant":
[
- {
  - "role":
    {
    "text": "string"
    },
  - "member":
    {
    "reference": "string",
    "display": "string"
    }
  }
],
"goal":
[
- {
  - "reference": "string"
  }
],
"activity":
[
- {
  - "detail":
    {
    "category":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
    },
    "code":
    {
    "text": "string"
    },
    "prohibited": true,
    "scheduledTiming":
    {
    "repeat":
    {
    "frequency": 0,
    "period": 0,
    "periodUnit": "string"
    }
    },
    "performer":
    [
    {
    "reference": "string",
    "display": "string"
    }
    ]
    }
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
activity-code	string Detail type of activity
activity-date	string <date> Specified date occurs within period specified by CarePlan.activity.timingSchedule
activity-reference	string Activity details defined in specific resource
based-on	string Fulfills care plan
care-team	string Who's involved in plan?
category	string Type of plan
condition	string Health issues this plan addresses
context	string Created in context of
date	string <date> Time period plan covers
definition	string Protocol or definition
encounter	string Created in context of
goal	string Desired outcome of plan
identifier	string External Ids for this plan
intent	string proposal \| plan \| order \| option
part-of	string Part of referenced CarePlan
patient	string Who care plan is for
performer	string "Matches if the practitioner is listed as a performer in any of the "simple" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)"
replaces	string CarePlan replaced by this CarePlan
status	string draft \| active \| suspended \| completed \| entered-in-error \| cancelled \| unknown
subject	string Who care plan is for
_format	string

Responses

200

Success

get /CarePlan

https://dev-pineapple-fhir.azurehealthcareapis.com/CarePlan

<no summary>

path Parameters

required

string

Responses

200

Success

get /CarePlan/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/CarePlan/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
contained required	Array of objects non-empty
subject required	object
status required	string non-empty
period required	object
addresses required	Array of objects non-empty
participant required	Array of objects non-empty
goal required	Array of objects non-empty
activity required	Array of objects non-empty

Responses

200

Success

put /CarePlan/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/CarePlan/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"contained":
[
- {
  - "resourceType": "string",
  - "id": "string",
  - "extension":
    [
    {
    "extension":
    [
    {
    "url": "string",
    "valueCodeableConcept":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    }
    }
    ],
    "url": "string"
    }
    ],
  - "subject":
    {
    "reference": "string",
    "display": "string"
    },
  - "description": "string",
  - "status": "string"
  }
],
"subject":
{
- "reference": "string",
- "display": "string"
},
"status": "string",
"period":
{
- "end": "string"
},
"addresses":
[
- {
  - "reference": "string",
  - "display": "string"
  }
],
"participant":
[
- {
  - "role":
    {
    "text": "string"
    },
  - "member":
    {
    "reference": "string",
    "display": "string"
    }
  }
],
"goal":
[
- {
  - "reference": "string"
  }
],
"activity":
[
- {
  - "detail":
    {
    "category":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
    },
    "code":
    {
    "text": "string"
    },
    "prohibited": true,
    "scheduledTiming":
    {
    "repeat":
    {
    "frequency": 0,
    "period": 0,
    "periodUnit": "string"
    }
    },
    "performer":
    [
    {
    "reference": "string",
    "display": "string"
    }
    ]
    }
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /CarePlan/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/CarePlan/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /CarePlan/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/CarePlan/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /CarePlan/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/CarePlan/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /CarePlan/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/CarePlan/{id}/_history/{vid}

CareTeam

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
contained required	Array of objects non-empty
subject required	object
period required	object
participant required	Array of objects non-empty

Responses

200

Success

post /CareTeam

https://dev-pineapple-fhir.azurehealthcareapis.com/CareTeam

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"contained":
[
- {
  - "resourceType": "string",
  - "id": "string",
  - "name":
    [
    {
    "family":
    [
    { }
    ],
    "given":
    [
    { }
    ]
    }
    ],
  - "practitionerRole":
    [
    {
    "specialty":
    [
    {
    "text": "string"
    }
    ]
    }
    ]
  }
],
"subject":
{
- "reference": "string",
- "display": "string"
},
"period":
{
- "end": "string"
},
"participant":
[
- {
  - "role":
    {
    "text": "string"
    },
  - "member":
    {
    "reference": "string",
    "display": "string"
    }
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
category	string Type of team
context	string Encounter or episode associated with CareTeam
date	string <date> Time period team covers
encounter	string Encounter or episode associated with CareTeam
identifier	string External Ids for this team
participant	string Who is involved
patient	string Who care team is for
status	string proposed \| active \| suspended \| inactive \| entered-in-error
subject	string Who care team is for
_format	string

Responses

200

Success

get /CareTeam

https://dev-pineapple-fhir.azurehealthcareapis.com/CareTeam

<no summary>

path Parameters

required

string

Responses

200

Success

get /CareTeam/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/CareTeam/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
contained required	Array of objects non-empty
subject required	object
period required	object
participant required	Array of objects non-empty

Responses

200

Success

put /CareTeam/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/CareTeam/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"contained":
[
- {
  - "resourceType": "string",
  - "id": "string",
  - "name":
    [
    {
    "family":
    [
    { }
    ],
    "given":
    [
    { }
    ]
    }
    ],
  - "practitionerRole":
    [
    {
    "specialty":
    [
    {
    "text": "string"
    }
    ]
    }
    ]
  }
],
"subject":
{
- "reference": "string",
- "display": "string"
},
"period":
{
- "end": "string"
},
"participant":
[
- {
  - "role":
    {
    "text": "string"
    },
  - "member":
    {
    "reference": "string",
    "display": "string"
    }
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /CareTeam/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/CareTeam/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /CareTeam/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/CareTeam/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /CareTeam/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/CareTeam/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /CareTeam/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/CareTeam/{id}/_history/{vid}

ChargeItem

<no summary>

Request Body schema: application/json

any (ChargeItem)

Responses

200

Success

post /ChargeItem

https://dev-pineapple-fhir.azurehealthcareapis.com/ChargeItem

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
account	string Account to place this charge
code	string A code that identifies the charge, like a billing code
context	string Encounter / Episode associated with event
entered-date	string <date> Date the charge item was entered
enterer	string Individual who was entering
factor-override	number Factor overriding the associated rules
identifier	string Business Identifier for item
occurrence	string <date> When the charged service was applied
participant-actor	string Individual who was performing
participant-role	string What type of performance was done
patient	string Individual service was done for/to
performing-organization	string Organization providing the charged sevice
price-override	integer Price overriding the associated rules
quantity	integer Quantity of which the charge item has been serviced
requesting-organization	string Organization requesting the charged service
service	string Which rendered service is being charged?
subject	string Individual service was done for/to
_format	string

Responses

200

Success

get /ChargeItem

https://dev-pineapple-fhir.azurehealthcareapis.com/ChargeItem

<no summary>

path Parameters

required

string

Responses

200

Success

get /ChargeItem/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ChargeItem/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

any (ChargeItem)

Responses

200

Success

put /ChargeItem/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ChargeItem/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

path Parameters

required

string

Responses

200

Success

delete /ChargeItem/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ChargeItem/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /ChargeItem/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ChargeItem/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /ChargeItem/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ChargeItem/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /ChargeItem/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/ChargeItem/{id}/_history/{vid}

Claim

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
type required	string non-empty
identifier required	Array of objects non-empty
created required	string non-empty
targetReference required	object
organizationReference required	object
use required	string non-empty
priority required	object
payee required	object
diagnosis required	Array of objects non-empty
patientReference required	object
coverage required	Array of objects non-empty
item required	Array of objects non-empty

Responses

200

Success

post /Claim

https://dev-pineapple-fhir.azurehealthcareapis.com/Claim

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"type": "string",
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"created": "string",
"targetReference":
{
- "reference": "string"
},
"organizationReference":
{
- "reference": "string"
},
"use": "string",
"priority":
{
- "code": "string"
},
"payee":
{
- "type":
  {
  - "code": "string"
  }
},
"diagnosis":
[
- {
  - "sequence": 0,
  - "diagnosis":
    {
    "code": "string"
    }
  }
],
"patientReference":
{
- "reference": "string"
},
"coverage":
[
- {
  - "sequence": 0,
  - "focal": true,
  - "coverageReference":
    {
    "reference": "string"
    }
  }
],
"item":
[
- {
  - "sequence": 0,
  - "type":
    {
    "code": "string"
    },
  - "providerReference":
    {
    "reference": "string"
    },
  - "service":
    {
    "code": "string"
    },
  - "servicedDate": "string",
  - "unitPrice":
    {
    "value": 0,
    "system": "string",
    "code": "string"
    },
  - "net":
    {
    "value": 0,
    "system": "string",
    "code": "string"
    }
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
care-team	string Member of the CareTeam
created	string <date> The creation date for the Claim
encounter	string Encounters associated with a billed line item
enterer	string The party responsible for the entry of the Claim
facility	string Facility responsible for the goods and services
identifier	string The primary identifier of the financial resource
insurer	string The target payor/insurer for the Claim
organization	string The reference to the providing organization
patient	string Patient receiving the services
payee	string The party receiving any payment for the Claim
priority	string Processing priority requested
provider	string Provider responsible for the Claim
use	string The kind of financial resource
_format	string

Responses

200

Success

get /Claim

https://dev-pineapple-fhir.azurehealthcareapis.com/Claim

<no summary>

path Parameters

required

string

Responses

200

Success

get /Claim/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Claim/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
type required	string non-empty
identifier required	Array of objects non-empty
created required	string non-empty
targetReference required	object
organizationReference required	object
use required	string non-empty
priority required	object
payee required	object
diagnosis required	Array of objects non-empty
patientReference required	object
coverage required	Array of objects non-empty
item required	Array of objects non-empty

Responses

200

Success

put /Claim/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Claim/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"type": "string",
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"created": "string",
"targetReference":
{
- "reference": "string"
},
"organizationReference":
{
- "reference": "string"
},
"use": "string",
"priority":
{
- "code": "string"
},
"payee":
{
- "type":
  {
  - "code": "string"
  }
},
"diagnosis":
[
- {
  - "sequence": 0,
  - "diagnosis":
    {
    "code": "string"
    }
  }
],
"patientReference":
{
- "reference": "string"
},
"coverage":
[
- {
  - "sequence": 0,
  - "focal": true,
  - "coverageReference":
    {
    "reference": "string"
    }
  }
],
"item":
[
- {
  - "sequence": 0,
  - "type":
    {
    "code": "string"
    },
  - "providerReference":
    {
    "reference": "string"
    },
  - "service":
    {
    "code": "string"
    },
  - "servicedDate": "string",
  - "unitPrice":
    {
    "value": 0,
    "system": "string",
    "code": "string"
    },
  - "net":
    {
    "value": 0,
    "system": "string",
    "code": "string"
    }
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Claim/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Claim/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Claim/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Claim/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Claim/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Claim/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Claim/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Claim/{id}/_history/{vid}

ClaimResponse

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
requestReference required	object
created required	string non-empty
organizationIdentifier required	object
outcome required	string non-empty
_outcome required	object
disposition required	string non-empty
payeeType required	object
item required	Array of objects non-empty
totalCost required	object
totalBenefit required	object
paymentDate required	string non-empty
_paymentDate required	object
paymentAmount required	object
paymentRef required	object

Responses

200

Success

post /ClaimResponse

https://dev-pineapple-fhir.azurehealthcareapis.com/ClaimResponse

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"requestReference":
{
- "reference": "string"
},
"created": "string",
"organizationIdentifier":
{
- "fhir_comments":
  [
  - { }
  ],
- "system": "string",
- "value": "string"
},
"outcome": "string",
"_outcome":
{
- "fhir_comments":
  [
  - { }
  ]
},
"disposition": "string",
"payeeType":
{
- "system": "string",
- "code": "string"
},
"item":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "sequenceLinkId": 0,
  - "adjudication":
    [
    {
    "category":
    {
    "code": "string"
    },
    "amount":
    {
    "value": 0,
    "system": "string",
    "code": "string"
    }
    }
    ]
  }
],
"totalCost":
{
- "value": 0,
- "system": "string",
- "code": "string"
},
"totalBenefit":
{
- "value": 0,
- "system": "string",
- "code": "string"
},
"paymentDate": "string",
"_paymentDate":
{
- "fhir_comments":
  [
  - { }
  ]
},
"paymentAmount":
{
- "value": 0,
- "system": "string",
- "code": "string"
},
"paymentRef":
{
- "system": "string",
- "value": "string"
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
created	string <date> The creation date
disposition	string The contents of the disposition message
identifier	string The identity of the claimresponse
insurer	string The organization who generated this resource
outcome	string The processing outcome
patient	string The subject of care.
payment-date	string <date> The expected paymentDate
request-provider	string The Provider of the claim
request	string The claim reference
_format	string

Responses

200

Success

get /ClaimResponse

https://dev-pineapple-fhir.azurehealthcareapis.com/ClaimResponse

<no summary>

path Parameters

required

string

Responses

200

Success

get /ClaimResponse/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ClaimResponse/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
requestReference required	object
created required	string non-empty
organizationIdentifier required	object
outcome required	string non-empty
_outcome required	object
disposition required	string non-empty
payeeType required	object
item required	Array of objects non-empty
totalCost required	object
totalBenefit required	object
paymentDate required	string non-empty
_paymentDate required	object
paymentAmount required	object
paymentRef required	object

Responses

200

Success

put /ClaimResponse/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ClaimResponse/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"requestReference":
{
- "reference": "string"
},
"created": "string",
"organizationIdentifier":
{
- "fhir_comments":
  [
  - { }
  ],
- "system": "string",
- "value": "string"
},
"outcome": "string",
"_outcome":
{
- "fhir_comments":
  [
  - { }
  ]
},
"disposition": "string",
"payeeType":
{
- "system": "string",
- "code": "string"
},
"item":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "sequenceLinkId": 0,
  - "adjudication":
    [
    {
    "category":
    {
    "code": "string"
    },
    "amount":
    {
    "value": 0,
    "system": "string",
    "code": "string"
    }
    }
    ]
  }
],
"totalCost":
{
- "value": 0,
- "system": "string",
- "code": "string"
},
"totalBenefit":
{
- "value": 0,
- "system": "string",
- "code": "string"
},
"paymentDate": "string",
"_paymentDate":
{
- "fhir_comments":
  [
  - { }
  ]
},
"paymentAmount":
{
- "value": 0,
- "system": "string",
- "code": "string"
},
"paymentRef":
{
- "system": "string",
- "value": "string"
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /ClaimResponse/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ClaimResponse/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /ClaimResponse/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ClaimResponse/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /ClaimResponse/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ClaimResponse/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /ClaimResponse/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/ClaimResponse/{id}/_history/{vid}

ClinicalImpression

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
patient required	object
assessor required	object
status required	string non-empty
date required	string non-empty
description required	string non-empty
problem required	Array of objects non-empty
investigations required	Array of objects non-empty
summary required	string non-empty
finding required	Array of objects non-empty
plan required	Array of objects non-empty

Responses

200

Success

post /ClinicalImpression

https://dev-pineapple-fhir.azurehealthcareapis.com/ClinicalImpression

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"patient":
{
- "reference": "string"
},
"assessor":
{
- "reference": "string"
},
"status": "string",
"date": "string",
"description": "string",
"problem":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "display": "string"
  }
],
"investigations":
[
- {
  - "code":
    {
    "text": "string"
    },
  - "item":
    [
    {
    "fhir_comments":
    [
    { }
    ],
    "display": "string"
    }
    ]
  }
],
"summary": "string",
"finding":
[
- {
  - "item":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
    }
  }
],
"plan":
[
- {
  - "display": "string",
  - "_display":
    {
    "fhir_comments":
    [
    { }
    ]
    }
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
action	string Action taken as part of assessment procedure
assessor	string The clinician performing the assessment
context	string Encounter or Episode created from
date	string <date> When the assessment was documented
finding-code	string What was found
finding-ref	string What was found
identifier	string Business identifier
investigation	string Record of a specific investigation
patient	string Patient or group assessed
previous	string Reference to last assessment
problem	string Relevant impressions of patient state
status	string draft \| completed \| entered-in-error
subject	string Patient or group assessed
_format	string

Responses

200

Success

get /ClinicalImpression

https://dev-pineapple-fhir.azurehealthcareapis.com/ClinicalImpression

<no summary>

path Parameters

required

string

Responses

200

Success

get /ClinicalImpression/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ClinicalImpression/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
patient required	object
assessor required	object
status required	string non-empty
date required	string non-empty
description required	string non-empty
problem required	Array of objects non-empty
investigations required	Array of objects non-empty
summary required	string non-empty
finding required	Array of objects non-empty
plan required	Array of objects non-empty

Responses

200

Success

put /ClinicalImpression/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ClinicalImpression/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"patient":
{
- "reference": "string"
},
"assessor":
{
- "reference": "string"
},
"status": "string",
"date": "string",
"description": "string",
"problem":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "display": "string"
  }
],
"investigations":
[
- {
  - "code":
    {
    "text": "string"
    },
  - "item":
    [
    {
    "fhir_comments":
    [
    { }
    ],
    "display": "string"
    }
    ]
  }
],
"summary": "string",
"finding":
[
- {
  - "item":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
    }
  }
],
"plan":
[
- {
  - "display": "string",
  - "_display":
    {
    "fhir_comments":
    [
    { }
    ]
    }
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /ClinicalImpression/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ClinicalImpression/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /ClinicalImpression/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ClinicalImpression/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /ClinicalImpression/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ClinicalImpression/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /ClinicalImpression/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/ClinicalImpression/{id}/_history/{vid}

CodeSystem

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
meta required	object
text required	object
url required	string non-empty
_url required	object
identifier required	object
version required	string non-empty
_version required	object
name required	string non-empty
status required	string non-empty
experimental required	boolean
publisher required	string non-empty
contact required	Array of objects non-empty
date required	string non-empty
description required	string non-empty
caseSensitive required	boolean
_caseSensitive required	object
content required	string non-empty
concept required	Array of objects non-empty

Responses

200

Success

post /CodeSystem

https://dev-pineapple-fhir.azurehealthcareapis.com/CodeSystem

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"meta":
{
- "profile":
  [
  - { }
  ]
},
"text":
{
- "status": "string",
- "div": "string"
},
"url": "string",
"_url":
{
- "fhir_comments":
  [
  - { }
  ]
},
"identifier":
{
- "fhir_comments":
  [
  - { }
  ],
- "system": "string",
- "value": "string"
},
"version": "string",
"_version":
{
- "fhir_comments":
  [
  - { }
  ]
},
"name": "string",
"status": "string",
"experimental": true,
"publisher": "string",
"contact":
[
- {
  - "name": "string",
  - "telecom":
    [
    {
    "system": "string",
    "value": "string"
    }
    ]
  }
],
"date": "string",
"description": "string",
"caseSensitive": true,
"_caseSensitive":
{
- "fhir_comments":
  [
  - { }
  ]
},
"content": "string",
"concept":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "code": "string",
  - "display": "string",
  - "definition": "string",
  - "designation":
    [
    {
    "use":
    {
    "system": "string",
    "code": "string"
    },
    "value": "string"
    }
    ]
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
code	string A code defined in the code system
content-mode	string not-present \| example \| fragment \| complete
date	string <date> The code system publication date
description	string The description of the code system
identifier	string External identifier for the code system
jurisdiction	string Intended jurisdiction for the code system
language	string A language in which a designation is provided
name	string Computationally friendly name of the code system
publisher	string Name of the publisher of the code system
status	string The current status of the code system
system	string The system for any codes defined by this code system (same as 'url')
title	string The human-friendly name of the code system
url	string The uri that identifies the code system
version	string The business version of the code system
_format	string

Responses

200

Success

get /CodeSystem

https://dev-pineapple-fhir.azurehealthcareapis.com/CodeSystem

<no summary>

path Parameters

required

string

Responses

200

Success

get /CodeSystem/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/CodeSystem/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
meta required	object
text required	object
url required	string non-empty
_url required	object
identifier required	object
version required	string non-empty
_version required	object
name required	string non-empty
status required	string non-empty
experimental required	boolean
publisher required	string non-empty
contact required	Array of objects non-empty
date required	string non-empty
description required	string non-empty
caseSensitive required	boolean
_caseSensitive required	object
content required	string non-empty
concept required	Array of objects non-empty

Responses

200

Success

put /CodeSystem/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/CodeSystem/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"meta":
{
- "profile":
  [
  - { }
  ]
},
"text":
{
- "status": "string",
- "div": "string"
},
"url": "string",
"_url":
{
- "fhir_comments":
  [
  - { }
  ]
},
"identifier":
{
- "fhir_comments":
  [
  - { }
  ],
- "system": "string",
- "value": "string"
},
"version": "string",
"_version":
{
- "fhir_comments":
  [
  - { }
  ]
},
"name": "string",
"status": "string",
"experimental": true,
"publisher": "string",
"contact":
[
- {
  - "name": "string",
  - "telecom":
    [
    {
    "system": "string",
    "value": "string"
    }
    ]
  }
],
"date": "string",
"description": "string",
"caseSensitive": true,
"_caseSensitive":
{
- "fhir_comments":
  [
  - { }
  ]
},
"content": "string",
"concept":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "code": "string",
  - "display": "string",
  - "definition": "string",
  - "designation":
    [
    {
    "use":
    {
    "system": "string",
    "code": "string"
    },
    "value": "string"
    }
    ]
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /CodeSystem/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/CodeSystem/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /CodeSystem/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/CodeSystem/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /CodeSystem/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/CodeSystem/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /CodeSystem/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/CodeSystem/{id}/_history/{vid}

Communication

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
category required	object
sender required	object
recipient required	Array of objects non-empty
payload required	Array of objects non-empty
status required	string non-empty
sent required	string non-empty
subject required	object

Responses

200

Success

post /Communication

https://dev-pineapple-fhir.azurehealthcareapis.com/Communication

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "type":
    {
    "text": "string"
    },
  - "system": "string",
  - "value": "string"
  }
],
"category":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string"
    }
  ],
- "text": "string"
},
"sender":
{
- "reference": "string"
},
"recipient":
[
- {
  - "reference": "string"
  }
],
"payload":
[
- {
  - "contentString": "string"
  }
],
"status": "string",
"sent": "string",
"subject":
{
- "reference": "string"
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
based-on	string Request fulfilled by this communication
category	string Message category
context	string Encounter or episode leading to message
definition	string Instantiates protocol or definition
encounter	string Encounter leading to message
identifier	string Unique identifier
medium	string A channel of communication
part-of	string Part of this action
patient	string Focus of message
received	string <date> When received
recipient	string Message recipient
sender	string Message sender
sent	string <date> When sent
status	string preparation \| in-progress \| suspended \| aborted \| completed \| entered-in-error
subject	string Focus of message
_format	string

Responses

200

Success

get /Communication

https://dev-pineapple-fhir.azurehealthcareapis.com/Communication

<no summary>

path Parameters

required

string

Responses

200

Success

get /Communication/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Communication/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
category required	object
sender required	object
recipient required	Array of objects non-empty
payload required	Array of objects non-empty
status required	string non-empty
sent required	string non-empty
subject required	object

Responses

200

Success

put /Communication/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Communication/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "type":
    {
    "text": "string"
    },
  - "system": "string",
  - "value": "string"
  }
],
"category":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string"
    }
  ],
- "text": "string"
},
"sender":
{
- "reference": "string"
},
"recipient":
[
- {
  - "reference": "string"
  }
],
"payload":
[
- {
  - "contentString": "string"
  }
],
"status": "string",
"sent": "string",
"subject":
{
- "reference": "string"
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Communication/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Communication/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Communication/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Communication/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Communication/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Communication/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Communication/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Communication/{id}/_history/{vid}

CommunicationRequest

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
subject required	object

Responses

200

Success

post /CommunicationRequest

https://dev-pineapple-fhir.azurehealthcareapis.com/CommunicationRequest

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"subject":
{
- "fhir_comments":
  [
  - { }
  ],
- "reference": "string"
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
authored	string <date> When request transitioned to being actionable
based-on	string Fulfills plan or proposal
category	string Message category
context	string Encounter or episode leading to message
encounter	string Encounter leading to message
group-identifier	string Composite request this is part of
identifier	string Unique identifier
medium	string A channel of communication
occurrence	string <date> When scheduled
patient	string Focus of message
priority	string Message urgency
recipient	string Message recipient
replaces	string Request(s) replaced by this request
requester	string Individual making the request
sender	string Message sender
status	string draft \| active \| suspended \| cancelled \| completed \| entered-in-error \| unknown
subject	string Focus of message
_format	string

Responses

200

Success

get /CommunicationRequest

https://dev-pineapple-fhir.azurehealthcareapis.com/CommunicationRequest

<no summary>

path Parameters

required

string

Responses

200

Success

get /CommunicationRequest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/CommunicationRequest/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
subject required	object

Responses

200

Success

put /CommunicationRequest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/CommunicationRequest/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"subject":
{
- "fhir_comments":
  [
  - { }
  ],
- "reference": "string"
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /CommunicationRequest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/CommunicationRequest/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /CommunicationRequest/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/CommunicationRequest/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /CommunicationRequest/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/CommunicationRequest/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /CommunicationRequest/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/CommunicationRequest/{id}/_history/{vid}

CompartmentDefinition

<no summary>

Request Body schema: application/json

any (CompartmentDefinition)

Responses

200

Success

post /CompartmentDefinition

https://dev-pineapple-fhir.azurehealthcareapis.com/CompartmentDefinition

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
code	string Patient \| Encounter \| RelatedPerson \| Practitioner \| Device
date	string <date> The compartment definition publication date
description	string The description of the compartment definition
jurisdiction	string Intended jurisdiction for the compartment definition
name	string Computationally friendly name of the compartment definition
publisher	string Name of the publisher of the compartment definition
resource	string Name of resource type
status	string The current status of the compartment definition
title	string The human-friendly name of the compartment definition
url	string The uri that identifies the compartment definition
_format	string

Responses

200

Success

get /CompartmentDefinition

https://dev-pineapple-fhir.azurehealthcareapis.com/CompartmentDefinition

<no summary>

path Parameters

required

string

Responses

200

Success

get /CompartmentDefinition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/CompartmentDefinition/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

any (CompartmentDefinition)

Responses

200

Success

put /CompartmentDefinition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/CompartmentDefinition/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

path Parameters

required

string

Responses

200

Success

delete /CompartmentDefinition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/CompartmentDefinition/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /CompartmentDefinition/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/CompartmentDefinition/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /CompartmentDefinition/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/CompartmentDefinition/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /CompartmentDefinition/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/CompartmentDefinition/{id}/_history/{vid}

Composition

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	object
date required	string non-empty
type required	object
class required	object
title required	string non-empty
status required	string non-empty
confidentiality required	string non-empty
subject required	object
author required	Array of objects non-empty
attester required	Array of objects non-empty
custodian required	object
event required	Array of objects non-empty
encounter required	object
section required	Array of objects non-empty

Responses

200

Success

post /Composition

https://dev-pineapple-fhir.azurehealthcareapis.com/Composition

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
{
- "system": "string",
- "value": "string"
},
"date": "string",
"type":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"class":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"title": "string",
"status": "string",
"confidentiality": "string",
"subject":
{
- "reference": "string",
- "display": "string"
},
"author":
[
- {
  - "reference": "string",
  - "display": "string"
  }
],
"attester":
[
- {
  - "mode":
    [
    { }
    ],
  - "time": "string",
  - "party":
    {
    "reference": "string",
    "display": "string"
    }
  }
],
"custodian":
{
- "reference": "string",
- "display": "string"
},
"event":
[
- {
  - "code":
    [
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    }
    ],
  - "period":
    {
    "start": "string",
    "end": "string"
    },
  - "detail":
    [
    {
    "reference": "string"
    }
    ]
  }
],
"encounter":
{
- "reference": "string"
},
"section":
[
- {
  - "title": "string",
  - "code":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    },
  - "text":
    {
    "status": "string",
    "div": "string"
    },
  - "mode": "string",
  - "orderedBy":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    },
  - "entry":
    [
    {
    "reference": "string"
    }
    ]
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
attester	string Who attested the composition
author	string Who and/or what authored the composition
class	string Categorization of Composition
confidentiality	string As defined by affinity domain
context	string Code(s) that apply to the event being documented
date	string <date> Composition editing time
encounter	string Context of the Composition
entry	string A reference to data that supports this section
identifier	string Logical identifier of composition (version-independent)
patient	string Who and/or what the composition is about
period	string <date> The period covered by the documentation
related-id	string Target of the relationship
related-ref	string Target of the relationship
section	string Classification of section (recommended)
status	string preliminary \| final \| amended \| entered-in-error
subject	string Who and/or what the composition is about
title	string Human Readable name/title
type	string Kind of composition (LOINC if possible)
_format	string

Responses

200

Success

get /Composition

https://dev-pineapple-fhir.azurehealthcareapis.com/Composition

<no summary>

path Parameters

required

string

Responses

200

Success

get /Composition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Composition/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	object
date required	string non-empty
type required	object
class required	object
title required	string non-empty
status required	string non-empty
confidentiality required	string non-empty
subject required	object
author required	Array of objects non-empty
attester required	Array of objects non-empty
custodian required	object
event required	Array of objects non-empty
encounter required	object
section required	Array of objects non-empty

Responses

200

Success

put /Composition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Composition/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
{
- "system": "string",
- "value": "string"
},
"date": "string",
"type":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"class":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"title": "string",
"status": "string",
"confidentiality": "string",
"subject":
{
- "reference": "string",
- "display": "string"
},
"author":
[
- {
  - "reference": "string",
  - "display": "string"
  }
],
"attester":
[
- {
  - "mode":
    [
    { }
    ],
  - "time": "string",
  - "party":
    {
    "reference": "string",
    "display": "string"
    }
  }
],
"custodian":
{
- "reference": "string",
- "display": "string"
},
"event":
[
- {
  - "code":
    [
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    }
    ],
  - "period":
    {
    "start": "string",
    "end": "string"
    },
  - "detail":
    [
    {
    "reference": "string"
    }
    ]
  }
],
"encounter":
{
- "reference": "string"
},
"section":
[
- {
  - "title": "string",
  - "code":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    },
  - "text":
    {
    "status": "string",
    "div": "string"
    },
  - "mode": "string",
  - "orderedBy":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    },
  - "entry":
    [
    {
    "reference": "string"
    }
    ]
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Composition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Composition/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Composition/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Composition/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Composition/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Composition/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Composition/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Composition/{id}/_history/{vid}

ConceptMap

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
url required	string non-empty
identifier required	object
version required	string non-empty
_version required	object
name required	string non-empty
_name required	object
status required	string non-empty
experimental required	boolean
publisher required	string non-empty
contact required	Array of objects non-empty
date required	string non-empty
description required	string non-empty
useContext required	Array of objects non-empty
requirements required	string non-empty
copyright required	string non-empty
sourceReference required	object
targetReference required	object
element required	Array of objects non-empty

Responses

200

Success

post /ConceptMap

https://dev-pineapple-fhir.azurehealthcareapis.com/ConceptMap

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"url": "string",
"identifier":
{
- "system": "string",
- "value": "string"
},
"version": "string",
"_version":
{
- "fhir_comments":
  [
  - { }
  ]
},
"name": "string",
"_name":
{
- "fhir_comments":
  [
  - { }
  ]
},
"status": "string",
"experimental": true,
"publisher": "string",
"contact":
[
- {
  - "name": "string",
  - "telecom":
    [
    {
    "system": "string",
    "value": "string"
    }
    ]
  }
],
"date": "string",
"description": "string",
"useContext":
[
- {
  - "text": "string"
  }
],
"requirements": "string",
"copyright": "string",
"sourceReference":
{
- "reference": "string"
},
"targetReference":
{
- "reference": "string"
},
"element":
[
- {
  - "system": "string",
  - "code": "string",
  - "target":
    [
    {
    "system": "string",
    "code": "string",
    "equivalence": "string"
    }
    ]
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
date	string <date> The concept map publication date
dependson	string Reference to property mapping depends on
description	string The description of the concept map
identifier	string External identifier for the concept map
jurisdiction	string Intended jurisdiction for the concept map
name	string Computationally friendly name of the concept map
other	string Canonical URL for other concept map
product	string Reference to property mapping depends on
publisher	string Name of the publisher of the concept map
source-code	string Identifies element being mapped
source	string Identifies the source of the concepts which are being mapped
source-system	string Code System (if value set crosses code systems)
source-uri	string Identifies the source of the concepts which are being mapped
status	string The current status of the concept map
target-code	string Code that identifies the target element
target	string Provides context to the mappings
target-system	string System of the target (if necessary)
target-uri	string Provides context to the mappings
title	string The human-friendly name of the concept map
url	string The uri that identifies the concept map
version	string The business version of the concept map
_format	string

Responses

200

Success

get /ConceptMap

https://dev-pineapple-fhir.azurehealthcareapis.com/ConceptMap

<no summary>

path Parameters

required

string

Responses

200

Success

get /ConceptMap/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ConceptMap/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
url required	string non-empty
identifier required	object
version required	string non-empty
_version required	object
name required	string non-empty
_name required	object
status required	string non-empty
experimental required	boolean
publisher required	string non-empty
contact required	Array of objects non-empty
date required	string non-empty
description required	string non-empty
useContext required	Array of objects non-empty
requirements required	string non-empty
copyright required	string non-empty
sourceReference required	object
targetReference required	object
element required	Array of objects non-empty

Responses

200

Success

put /ConceptMap/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ConceptMap/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"url": "string",
"identifier":
{
- "system": "string",
- "value": "string"
},
"version": "string",
"_version":
{
- "fhir_comments":
  [
  - { }
  ]
},
"name": "string",
"_name":
{
- "fhir_comments":
  [
  - { }
  ]
},
"status": "string",
"experimental": true,
"publisher": "string",
"contact":
[
- {
  - "name": "string",
  - "telecom":
    [
    {
    "system": "string",
    "value": "string"
    }
    ]
  }
],
"date": "string",
"description": "string",
"useContext":
[
- {
  - "text": "string"
  }
],
"requirements": "string",
"copyright": "string",
"sourceReference":
{
- "reference": "string"
},
"targetReference":
{
- "reference": "string"
},
"element":
[
- {
  - "system": "string",
  - "code": "string",
  - "target":
    [
    {
    "system": "string",
    "code": "string",
    "equivalence": "string"
    }
    ]
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /ConceptMap/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ConceptMap/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /ConceptMap/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ConceptMap/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /ConceptMap/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ConceptMap/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /ConceptMap/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/ConceptMap/{id}/_history/{vid}

Condition

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
patient required	object
code required	object
category required	object
verificationStatus required	string non-empty
severity required	object
onsetDateTime required	string non-empty
bodySite required	Array of objects non-empty

Responses

200

Success

post /Condition

https://dev-pineapple-fhir.azurehealthcareapis.com/Condition

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"patient":
{
- "reference": "string"
},
"code":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ],
- "text": "string"
},
"category":
{
- "coding":
  [
  - {
    "fhir_comments":
    [
    { }
    ],
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"verificationStatus": "string",
"severity":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"onsetDateTime": "string",
"bodySite":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ],
  - "text": "string"
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
abatement-age	integer Abatement as age or age range
abatement-boolean	string Abatement boolean (boolean is true or non-boolean values are present)
abatement-date	string <date> Date-related abatements (dateTime and period)
abatement-string	string Abatement as a string
asserted-date	string <date> Date record was believed accurate
asserter	string Person who asserts this condition
body-site	string Anatomical location, if relevant
category	string The category of the condition
clinical-status	string The clinical status of the condition
code	string Code for the condition
context	string Encounter or episode when condition first asserted
encounter	string Encounter when condition first asserted
evidence-detail	string Supporting information found elsewhere
evidence	string Manifestation/symptom
identifier	string A unique identifier of the condition record
onset-age	integer Onsets as age or age range
onset-date	string <date> Date related onsets (dateTime and Period)
onset-info	string Onsets as a string
patient	string Who has the condition?
severity	string The severity of the condition
stage	string Simple summary (disease specific)
subject	string Who has the condition?
verification-status	string provisional \| differential \| confirmed \| refuted \| entered-in-error \| unknown
_format	string

Responses

200

Success

get /Condition

https://dev-pineapple-fhir.azurehealthcareapis.com/Condition

<no summary>

path Parameters

required

string

Responses

200

Success

get /Condition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Condition/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
patient required	object
code required	object
category required	object
verificationStatus required	string non-empty
severity required	object
onsetDateTime required	string non-empty
bodySite required	Array of objects non-empty

Responses

200

Success

put /Condition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Condition/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"patient":
{
- "reference": "string"
},
"code":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ],
- "text": "string"
},
"category":
{
- "coding":
  [
  - {
    "fhir_comments":
    [
    { }
    ],
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"verificationStatus": "string",
"severity":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"onsetDateTime": "string",
"bodySite":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ],
  - "text": "string"
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Condition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Condition/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Condition/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Condition/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Condition/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Condition/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Condition/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Condition/{id}/_history/{vid}

Contract

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
fhir_comments required	Array of objects
id required	string non-empty
text required	object

Responses

200

Success

post /Contract

https://dev-pineapple-fhir.azurehealthcareapis.com/Contract

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"fhir_comments":
[
- { }
],
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
agent	string Agent to the Contact
authority	string The authority of the contract
domain	string The domain of the contract
identifier	string The identity of the contract
issued	string <date> The date/time the contract was issued
patient	string The identity of the subject of the contract (if a patient)
signer	string Contract Signatory Party
subject	string The identity of the subject of the contract
term-topic	string The identity of the topic of the contract terms
_format	string

Responses

200

Success

get /Contract

https://dev-pineapple-fhir.azurehealthcareapis.com/Contract

<no summary>

path Parameters

required

string

Responses

200

Success

get /Contract/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Contract/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
fhir_comments required	Array of objects
id required	string non-empty
text required	object

Responses

200

Success

put /Contract/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Contract/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"fhir_comments":
[
- { }
],
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Contract/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Contract/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Contract/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Contract/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Contract/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Contract/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Contract/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Contract/{id}/_history/{vid}

Coverage

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
issuerReference required	object
period required	object
type required	object
planholderReference required	object
beneficiaryReference required	object
relationship required	object
identifier required	Array of objects non-empty
plan required	string non-empty
subPlan required	string non-empty
dependent required	number
sequence required	number

Responses

200

Success

post /Coverage

https://dev-pineapple-fhir.azurehealthcareapis.com/Coverage

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"issuerReference":
{
- "reference": "string"
},
"period":
{
- "start": "string",
- "end": "string"
},
"type":
{
- "system": "string",
- "code": "string",
- "display": "string"
},
"planholderReference":
{
- "reference": "string"
},
"beneficiaryReference":
{
- "reference": "string"
},
"relationship":
{
- "code": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"plan": "string",
"subPlan": "string",
"dependent": 0,
"sequence": 0

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
beneficiary	string Covered party
class	string Class identifier
dependent	string Dependent number
group	string Group identifier
identifier	string The primary identifier of the insured and the coverage
payor	string The identity of the insurer or party paying for services
plan	string A plan or policy identifier
policy-holder	string Reference to the policyholder
sequence	string Sequence number
subclass	string Sub-class identifier
subgroup	string Sub-group identifier
subplan	string Sub-plan identifier
subscriber	string Reference to the subscriber
type	string The kind of coverage (health plan, auto, Workers Compensation)
_format	string

Responses

200

Success

get /Coverage

https://dev-pineapple-fhir.azurehealthcareapis.com/Coverage

<no summary>

path Parameters

required

string

Responses

200

Success

get /Coverage/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Coverage/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
issuerReference required	object
period required	object
type required	object
planholderReference required	object
beneficiaryReference required	object
relationship required	object
identifier required	Array of objects non-empty
plan required	string non-empty
subPlan required	string non-empty
dependent required	number
sequence required	number

Responses

200

Success

put /Coverage/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Coverage/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"issuerReference":
{
- "reference": "string"
},
"period":
{
- "start": "string",
- "end": "string"
},
"type":
{
- "system": "string",
- "code": "string",
- "display": "string"
},
"planholderReference":
{
- "reference": "string"
},
"beneficiaryReference":
{
- "reference": "string"
},
"relationship":
{
- "code": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"plan": "string",
"subPlan": "string",
"dependent": 0,
"sequence": 0

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Coverage/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Coverage/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Coverage/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Coverage/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Coverage/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Coverage/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Coverage/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Coverage/{id}/_history/{vid}

DataElement

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
contained required	Array of objects non-empty
identifier required	Array of objects non-empty
version required	string non-empty
status required	string non-empty
publisher required	string non-empty
name required	string non-empty
useContext required	Array of objects non-empty
element required	Array of objects non-empty

Responses

200

Success

post /DataElement

https://dev-pineapple-fhir.azurehealthcareapis.com/DataElement

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"contained":
[
- {
  - "resourceType": "string",
  - "id": "string",
  - "url": "string",
  - "version": "string",
  - "name": "string",
  - "status": "string",
  - "description": "string",
  - "compose":
    {
    "include":
    [
    {
    "system": "string",
    "concept":
    [
    {
    "fhir_comments":
    [
    { }
    ],
    "code": "string",
    "display": "string"
    }
    ]
    }
    ]
    }
  }
],
"identifier":
[
- {
  - "value": "string"
  }
],
"version": "string",
"status": "string",
"publisher": "string",
"name": "string",
"useContext":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "display": "string"
    }
    ]
  }
],
"element":
[
- {
  - "extension":
    [
    {
    "url": "string",
    "valueInteger": 0
    }
    ],
  - "path": "string",
  - "definition": "string",
  - "type":
    [
    {
    "code": "string"
    }
    ],
  - "maxLength": 0,
  - "binding":
    {
    "strength": "string",
    "valueSetReference":
    {
    "extension":
    [
    {
    "url": "string",
    "valueReference":
    {
    "reference": "string"
    }
    }
    ],
    "reference": "string"
    }
    }
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
code	string A code for the data element (server may choose to do subsumption)
date	string <date> The data element publication date
description	string Text search in the description of the data element. This corresponds to the definition of the first DataElement.element.
identifier	string External identifier for the data element
jurisdiction	string Intended jurisdiction for the data element
name	string Computationally friendly name of the data element
publisher	string Name of the publisher of the data element
status	string The current status of the data element
stringency	string The stringency of the data element definition
title	string The human-friendly name of the data element
url	string The uri that identifies the data element
version	string The business version of the data element
_format	string

Responses

200

Success

get /DataElement

https://dev-pineapple-fhir.azurehealthcareapis.com/DataElement

<no summary>

path Parameters

required

string

Responses

200

Success

get /DataElement/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/DataElement/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
contained required	Array of objects non-empty
identifier required	Array of objects non-empty
version required	string non-empty
status required	string non-empty
publisher required	string non-empty
name required	string non-empty
useContext required	Array of objects non-empty
element required	Array of objects non-empty

Responses

200

Success

put /DataElement/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/DataElement/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"contained":
[
- {
  - "resourceType": "string",
  - "id": "string",
  - "url": "string",
  - "version": "string",
  - "name": "string",
  - "status": "string",
  - "description": "string",
  - "compose":
    {
    "include":
    [
    {
    "system": "string",
    "concept":
    [
    {
    "fhir_comments":
    [
    { }
    ],
    "code": "string",
    "display": "string"
    }
    ]
    }
    ]
    }
  }
],
"identifier":
[
- {
  - "value": "string"
  }
],
"version": "string",
"status": "string",
"publisher": "string",
"name": "string",
"useContext":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "display": "string"
    }
    ]
  }
],
"element":
[
- {
  - "extension":
    [
    {
    "url": "string",
    "valueInteger": 0
    }
    ],
  - "path": "string",
  - "definition": "string",
  - "type":
    [
    {
    "code": "string"
    }
    ],
  - "maxLength": 0,
  - "binding":
    {
    "strength": "string",
    "valueSetReference":
    {
    "extension":
    [
    {
    "url": "string",
    "valueReference":
    {
    "reference": "string"
    }
    }
    ],
    "reference": "string"
    }
    }
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /DataElement/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/DataElement/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /DataElement/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/DataElement/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /DataElement/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/DataElement/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /DataElement/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/DataElement/{id}/_history/{vid}

DetectedIssue

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
category required	object
severity required	string non-empty
implicated required	Array of objects non-empty
detail required	string non-empty
date required	string non-empty
author required	object
mitigation required	Array of objects non-empty

Responses

200

Success

post /DetectedIssue

https://dev-pineapple-fhir.azurehealthcareapis.com/DetectedIssue

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"category":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"severity": "string",
"implicated":
[
- {
  - "reference": "string",
  - "display": "string"
  }
],
"detail": "string",
"date": "string",
"author":
{
- "reference": "string"
},
"mitigation":
[
- {
  - "action":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ],
    "text": "string"
    },
  - "date": "string",
  - "author":
    {
    "reference": "string",
    "display": "string"
    }
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
author	string The provider or device that identified the issue
category	string Issue Category, e.g. drug-drug, duplicate therapy, etc.
date	string <date> When identified
identifier	string Unique id for the detected issue
implicated	string Problem resource
patient	string Associated patient
_format	string

Responses

200

Success

get /DetectedIssue

https://dev-pineapple-fhir.azurehealthcareapis.com/DetectedIssue

<no summary>

path Parameters

required

string

Responses

200

Success

get /DetectedIssue/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/DetectedIssue/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
category required	object
severity required	string non-empty
implicated required	Array of objects non-empty
detail required	string non-empty
date required	string non-empty
author required	object
mitigation required	Array of objects non-empty

Responses

200

Success

put /DetectedIssue/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/DetectedIssue/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"category":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"severity": "string",
"implicated":
[
- {
  - "reference": "string",
  - "display": "string"
  }
],
"detail": "string",
"date": "string",
"author":
{
- "reference": "string"
},
"mitigation":
[
- {
  - "action":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ],
    "text": "string"
    },
  - "date": "string",
  - "author":
    {
    "reference": "string",
    "display": "string"
    }
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /DetectedIssue/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/DetectedIssue/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /DetectedIssue/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/DetectedIssue/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /DetectedIssue/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/DetectedIssue/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /DetectedIssue/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/DetectedIssue/{id}/_history/{vid}

Device

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
_id required	object
text required	object
identifier required	Array of objects non-empty
status required	string non-empty
type required	object
lotNumber required	string non-empty
manufacturer required	string non-empty
model required	string non-empty
contact required	Array of objects non-empty
note required	Array of objects non-empty

Responses

200

Success

post /Device

https://dev-pineapple-fhir.azurehealthcareapis.com/Device

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"_id":
{
- "fhir_comments":
  [
  - { }
  ]
},
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"status": "string",
"type":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ],
- "text": "string"
},
"lotNumber": "string",
"manufacturer": "string",
"model": "string",
"contact":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"note":
[
- {
  - "authorReference":
    {
    "reference": "string"
    },
  - "time": "string",
  - "text": "string"
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
device-name	string A server defined search that may match any of the string fields in the Device.udi.name or Device.type.coding.display or Device.type.text
identifier	string Instance id from manufacturer, owner, and others
location	string A location, where the resource is found
manufacturer	string The manufacturer of the device
model	string The model of the device
organization	string The organization responsible for the device
patient	string Patient information, if the resource is affixed to a person
status	string active \| inactive \| entered-in-error \| unknown
type	string The type of the device
udi-carrier	string UDI Barcode (RFID or other technology) string either in HRF format or AIDC format converted to base64 string.
udi-di	string The udi Device Identifier (DI)
url	string Network address to contact device
_format	string

Responses

200

Success

get /Device

https://dev-pineapple-fhir.azurehealthcareapis.com/Device

<no summary>

path Parameters

required

string

Responses

200

Success

get /Device/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Device/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
_id required	object
text required	object
identifier required	Array of objects non-empty
status required	string non-empty
type required	object
lotNumber required	string non-empty
manufacturer required	string non-empty
model required	string non-empty
contact required	Array of objects non-empty
note required	Array of objects non-empty

Responses

200

Success

put /Device/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Device/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"_id":
{
- "fhir_comments":
  [
  - { }
  ]
},
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"status": "string",
"type":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ],
- "text": "string"
},
"lotNumber": "string",
"manufacturer": "string",
"model": "string",
"contact":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"note":
[
- {
  - "authorReference":
    {
    "reference": "string"
    },
  - "time": "string",
  - "text": "string"
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Device/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Device/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Device/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Device/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Device/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Device/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Device/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Device/{id}/_history/{vid}

DeviceComponent

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
_id required	object
text required	object
contained required	Array of objects non-empty
type required	object
identifier required	object
lastSystemChange required	string non-empty
source required	object
operationalStatus required	Array of objects non-empty
languageCode required	object

Responses

200

Success

post /DeviceComponent

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceComponent

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"_id":
{
- "fhir_comments":
  [
  - { }
  ]
},
"text":
{
- "status": "string",
- "div": "string"
},
"contained":
[
- {
  - "resourceType": "string",
  - "id": "string",
  - "identifier":
    [
    {
    "type":
    {
    "text": "string"
    },
    "system": "string",
    "value": "string"
    }
    ],
  - "type":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    },
  - "manufacturer": "string",
  - "model": "string"
  }
],
"type":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"identifier":
{
- "type":
  {
  - "text": "string"
  },
- "value": "string"
},
"lastSystemChange": "string",
"source":
{
- "reference": "string"
},
"operationalStatus":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"languageCode":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string"
    }
  ]
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
identifier	string The identifier of the component
parent	string The parent DeviceComponent resource
source	string The device source
type	string The device component type
_format	string

Responses

200

Success

get /DeviceComponent

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceComponent

<no summary>

path Parameters

required

string

Responses

200

Success

get /DeviceComponent/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceComponent/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
_id required	object
text required	object
contained required	Array of objects non-empty
type required	object
identifier required	object
lastSystemChange required	string non-empty
source required	object
operationalStatus required	Array of objects non-empty
languageCode required	object

Responses

200

Success

put /DeviceComponent/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceComponent/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"_id":
{
- "fhir_comments":
  [
  - { }
  ]
},
"text":
{
- "status": "string",
- "div": "string"
},
"contained":
[
- {
  - "resourceType": "string",
  - "id": "string",
  - "identifier":
    [
    {
    "type":
    {
    "text": "string"
    },
    "system": "string",
    "value": "string"
    }
    ],
  - "type":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    },
  - "manufacturer": "string",
  - "model": "string"
  }
],
"type":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"identifier":
{
- "type":
  {
  - "text": "string"
  },
- "value": "string"
},
"lastSystemChange": "string",
"source":
{
- "reference": "string"
},
"operationalStatus":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"languageCode":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string"
    }
  ]
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /DeviceComponent/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceComponent/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /DeviceComponent/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceComponent/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /DeviceComponent/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceComponent/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /DeviceComponent/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceComponent/{id}/_history/{vid}

DeviceMetric

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
type required	object
identifier required	object
unit required	object
category required	string non-empty

Responses

200

Success

post /DeviceMetric

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceMetric

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"type":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"identifier":
{
- "system": "string",
- "value": "string"
},
"unit":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"category": "string"

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
category	string The category of the metric
identifier	string The identifier of the metric
parent	string The parent DeviceMetric resource
source	string The device resource
type	string The component type
_format	string

Responses

200

Success

get /DeviceMetric

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceMetric

<no summary>

path Parameters

required

string

Responses

200

Success

get /DeviceMetric/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceMetric/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
type required	object
identifier required	object
unit required	object
category required	string non-empty

Responses

200

Success

put /DeviceMetric/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceMetric/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"type":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"identifier":
{
- "system": "string",
- "value": "string"
},
"unit":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"category": "string"

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /DeviceMetric/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceMetric/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /DeviceMetric/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceMetric/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /DeviceMetric/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceMetric/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /DeviceMetric/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceMetric/{id}/_history/{vid}

DeviceRequest

<no summary>

Request Body schema: application/json

any (DeviceRequest)

Responses

200

Success

post /DeviceRequest

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceRequest

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
authored-on	string <date> When the request transitioned to being actionable
based-on	string Plan/proposal/order fulfilled by this request
code	string Code for what is being requested/ordered
definition	string Protocol or definition followed by this request
device	string Reference to resource that is being requested/ordered
encounter	string Encounter or Episode during which request was created
event-date	string <date> When service should occur
group-identifier	string Composite request this is part of
identifier	string Business identifier for request/order
intent	string proposal \| plan \| original-order \|reflex-order
patient	string Individual the service is ordered for
performer	string Desired performer for service
priorrequest	string Request takes the place of referenced completed or terminated requests
requester	string Who/what is requesting service
status	string entered-in-error \| draft \| active \|suspended \| completed
subject	string Individual the service is ordered for
_format	string

Responses

200

Success

get /DeviceRequest

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceRequest

<no summary>

path Parameters

required

string

Responses

200

Success

get /DeviceRequest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceRequest/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

any (DeviceRequest)

Responses

200

Success

put /DeviceRequest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceRequest/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

path Parameters

required

string

Responses

200

Success

delete /DeviceRequest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceRequest/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /DeviceRequest/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceRequest/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /DeviceRequest/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceRequest/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /DeviceRequest/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceRequest/{id}/_history/{vid}

DeviceUseStatement

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
device required	object
subject required	object

Responses

200

Success

post /DeviceUseStatement

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceUseStatement

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"device":
{
- "fhir_comments":
  [
  - { }
  ],
- "reference": "string"
},
"subject":
{
- "reference": "string"
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
device	string Search by device
identifier	string Search by identifier
patient	string Search by subject - a patient
subject	string Search by subject
_format	string

Responses

200

Success

get /DeviceUseStatement

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceUseStatement

<no summary>

path Parameters

required

string

Responses

200

Success

get /DeviceUseStatement/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceUseStatement/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
device required	object
subject required	object

Responses

200

Success

put /DeviceUseStatement/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceUseStatement/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"device":
{
- "fhir_comments":
  [
  - { }
  ],
- "reference": "string"
},
"subject":
{
- "reference": "string"
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /DeviceUseStatement/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceUseStatement/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /DeviceUseStatement/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceUseStatement/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /DeviceUseStatement/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceUseStatement/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /DeviceUseStatement/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/DeviceUseStatement/{id}/_history/{vid}

DiagnosticReport

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
contained required	Array of objects non-empty
identifier required	Array of objects non-empty
status required	string non-empty
category required	object
code required	object
subject required	object
encounter required	object
effectiveDateTime required	string non-empty
issued required	string non-empty
_issued required	object
performer required	object
result required	Array of objects non-empty
presentedForm required	Array of objects non-empty

Responses

200

Success

post /DiagnosticReport

https://dev-pineapple-fhir.azurehealthcareapis.com/DiagnosticReport

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"contained":
[
- {
  - "resourceType": "string",
  - "id": "string",
  - "_id":
    {
    "fhir_comments":
    [
    { }
    ]
    },
  - "status": "string",
  - "code":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ],
    "text": "string"
    },
  - "subject":
    {
    "reference": "string"
    },
  - "performer":
    [
    {
    "reference": "string",
    "display": "string"
    }
    ],
  - "valueQuantity":
    {
    "value": 0,
    "unit": "string",
    "system": "string",
    "code": "string"
    },
  - "referenceRange":
    [
    {
    "low":
    {
    "value": 0,
    "unit": "string",
    "system": "string",
    "code": "string"
    },
    "high":
    {
    "value": 0,
    "unit": "string",
    "system": "string",
    "code": "string"
    }
    }
    ]
  }
],
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"status": "string",
"category":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string"
    }
  ]
},
"code":
{
- "fhir_comments":
  [
  - { }
  ],
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ],
- "text": "string"
},
"subject":
{
- "reference": "string"
},
"encounter":
{
- "reference": "string"
},
"effectiveDateTime": "string",
"issued": "string",
"_issued":
{
- "fhir_comments":
  [
  - { }
  ]
},
"performer":
{
- "reference": "string",
- "display": "string"
},
"result":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "reference": "string"
  }
],
"presentedForm":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "contentType": "string",
  - "language": "string",
  - "data": "string",
  - "title": "string"
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
based-on	string Reference to the procedure request.
category	string Which diagnostic discipline/department created the report
code	string The code for the report as a whole, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result
context	string Healthcare event (Episode of Care or Encounter) related to the report
date	string <date> The clinically relevant time of the report
diagnosis	string A coded diagnosis on the report
encounter	string The Encounter when the order was made
identifier	string An identifier for the report
image	string A reference to the image source.
issued	string <date> When the report was issued
patient	string The subject of the report if a patient
performer	string Who was the source of the report (organization)
result	string Link to an atomic result (observation resource)
specimen	string The specimen details
status	string The status of the report
subject	string The subject of the report
_format	string

Responses

200

Success

get /DiagnosticReport

https://dev-pineapple-fhir.azurehealthcareapis.com/DiagnosticReport

<no summary>

path Parameters

required

string

Responses

200

Success

get /DiagnosticReport/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/DiagnosticReport/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
contained required	Array of objects non-empty
identifier required	Array of objects non-empty
status required	string non-empty
category required	object
code required	object
subject required	object
encounter required	object
effectiveDateTime required	string non-empty
issued required	string non-empty
_issued required	object
performer required	object
result required	Array of objects non-empty
presentedForm required	Array of objects non-empty

Responses

200

Success

put /DiagnosticReport/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/DiagnosticReport/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"contained":
[
- {
  - "resourceType": "string",
  - "id": "string",
  - "_id":
    {
    "fhir_comments":
    [
    { }
    ]
    },
  - "status": "string",
  - "code":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ],
    "text": "string"
    },
  - "subject":
    {
    "reference": "string"
    },
  - "performer":
    [
    {
    "reference": "string",
    "display": "string"
    }
    ],
  - "valueQuantity":
    {
    "value": 0,
    "unit": "string",
    "system": "string",
    "code": "string"
    },
  - "referenceRange":
    [
    {
    "low":
    {
    "value": 0,
    "unit": "string",
    "system": "string",
    "code": "string"
    },
    "high":
    {
    "value": 0,
    "unit": "string",
    "system": "string",
    "code": "string"
    }
    }
    ]
  }
],
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"status": "string",
"category":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string"
    }
  ]
},
"code":
{
- "fhir_comments":
  [
  - { }
  ],
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ],
- "text": "string"
},
"subject":
{
- "reference": "string"
},
"encounter":
{
- "reference": "string"
},
"effectiveDateTime": "string",
"issued": "string",
"_issued":
{
- "fhir_comments":
  [
  - { }
  ]
},
"performer":
{
- "reference": "string",
- "display": "string"
},
"result":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "reference": "string"
  }
],
"presentedForm":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "contentType": "string",
  - "language": "string",
  - "data": "string",
  - "title": "string"
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /DiagnosticReport/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/DiagnosticReport/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /DiagnosticReport/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/DiagnosticReport/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /DiagnosticReport/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/DiagnosticReport/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /DiagnosticReport/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/DiagnosticReport/{id}/_history/{vid}

DocumentManifest

<no summary>

Request Body schema: application/json

any (DocumentManifest)

Responses

200

Success

post /DocumentManifest

https://dev-pineapple-fhir.azurehealthcareapis.com/DocumentManifest

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
author	string Who and/or what authored the manifest
content-ref	string Contents of this set of documents
created	string <date> When this document manifest created
description	string Human-readable description (title)
identifier	string Unique Identifier for the set of documents
patient	string The subject of the set of documents
recipient	string Intended to get notified about this set of documents
related-id	string Identifiers of things that are related
related-ref	string Related Resource
source	string The source system/application/software
status	string current \| superseded \| entered-in-error
subject	string The subject of the set of documents
type	string Kind of document set
_format	string

Responses

200

Success

get /DocumentManifest

https://dev-pineapple-fhir.azurehealthcareapis.com/DocumentManifest

<no summary>

path Parameters

required

string

Responses

200

Success

get /DocumentManifest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/DocumentManifest/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

any (DocumentManifest)

Responses

200

Success

put /DocumentManifest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/DocumentManifest/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

path Parameters

required

string

Responses

200

Success

delete /DocumentManifest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/DocumentManifest/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /DocumentManifest/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/DocumentManifest/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /DocumentManifest/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/DocumentManifest/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /DocumentManifest/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/DocumentManifest/{id}/_history/{vid}

DocumentReference

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
contained required	Array of objects non-empty
masterIdentifier required	object
identifier required	Array of objects non-empty
subject required	object
type required	object
class required	object
author required	Array of objects non-empty
custodian required	object
authenticator required	object
created required	string non-empty
indexed required	string non-empty
status required	string non-empty
docStatus required	object
relatesTo required	Array of objects non-empty
description required	string non-empty
securityLabel required	Array of objects non-empty
content required	Array of objects non-empty
context required	object

Responses

200

Success

post /DocumentReference

https://dev-pineapple-fhir.azurehealthcareapis.com/DocumentReference

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "fhir_comments":
  [
  - { }
  ],
- "status": "string",
- "div": "string"
},
"contained":
[
- {
  - "resourceType": "string",
  - "id": "string",
  - "name":
    [
    {
    "family":
    [
    { }
    ],
    "given":
    [
    { }
    ]
    }
    ],
  - "practitionerRole":
    [
    {
    "organization":
    {
    "display": "string"
    },
    "role":
    {
    "text": "string"
    },
    "specialty":
    [
    {
    "text": "string"
    }
    ]
    }
    ]
  }
],
"masterIdentifier":
{
- "system": "string",
- "value": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"subject":
{
- "reference": "string"
},
"type":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"class":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"author":
[
- {
  - "reference": "string"
  }
],
"custodian":
{
- "reference": "string"
},
"authenticator":
{
- "reference": "string"
},
"created": "string",
"indexed": "string",
"status": "string",
"docStatus":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"relatesTo":
[
- {
  - "code": "string",
  - "target":
    {
    "reference": "string"
    }
  }
],
"description": "string",
"securityLabel":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"content":
[
- {
  - "attachment":
    {
    "contentType": "string",
    "language": "string",
    "url": "string",
    "size": 0,
    "hash": "string"
    },
  - "format":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"context":
{
- "encounter":
  {
  - "reference": "string"
  },
- "event":
  [
  - {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    }
  ],
- "period":
  {
  - "start": "string",
  - "end": "string"
  },
- "facilityType":
  {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
  },
- "practiceSetting":
  {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
  },
- "sourcePatientInfo":
  {
  - "reference": "string"
  },
- "related":
  [
  - {
    "identifier":
    {
    "system": "string",
    "value": "string"
    },
    "ref":
    {
    "reference": "string"
    }
    }
  ]
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
authenticator	string Who/what authenticated the document
author	string Who and/or what authored the document
class	string Categorization of document
created	string <date> Document creation time
custodian	string Organization which maintains the document
description	string Human-readable description (title)
encounter	string Context of the document content
event	string Main clinical acts documented
facility	string Kind of facility where patient was seen
format	string Format/content rules for the document
identifier	string Master Version Specific Identifier
indexed	string <date> When this document reference was created
language	string Human language of the content (BCP-47)
location	string Uri where the data can be found
patient	string Who/what is the subject of the document
period	string <date> Time of service that is being documented
related-id	string Identifier of related objects or events
related-ref	string Related Resource
relatesto	string Target of the relationship
relationship	string Combination of relation and relatesTo
relation	string replaces \| transforms \| signs \| appends
securitylabel	string Document security-tags
setting	string Additional details about where the content was created (e.g. clinical specialty)
status	string current \| superseded \| entered-in-error
subject	string Who/what is the subject of the document
type	string Kind of document (LOINC if possible)
_format	string

Responses

200

Success

get /DocumentReference

https://dev-pineapple-fhir.azurehealthcareapis.com/DocumentReference

<no summary>

path Parameters

required

string

Responses

200

Success

get /DocumentReference/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/DocumentReference/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
contained required	Array of objects non-empty
masterIdentifier required	object
identifier required	Array of objects non-empty
subject required	object
type required	object
class required	object
author required	Array of objects non-empty
custodian required	object
authenticator required	object
created required	string non-empty
indexed required	string non-empty
status required	string non-empty
docStatus required	object
relatesTo required	Array of objects non-empty
description required	string non-empty
securityLabel required	Array of objects non-empty
content required	Array of objects non-empty
context required	object

Responses

200

Success

put /DocumentReference/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/DocumentReference/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "fhir_comments":
  [
  - { }
  ],
- "status": "string",
- "div": "string"
},
"contained":
[
- {
  - "resourceType": "string",
  - "id": "string",
  - "name":
    [
    {
    "family":
    [
    { }
    ],
    "given":
    [
    { }
    ]
    }
    ],
  - "practitionerRole":
    [
    {
    "organization":
    {
    "display": "string"
    },
    "role":
    {
    "text": "string"
    },
    "specialty":
    [
    {
    "text": "string"
    }
    ]
    }
    ]
  }
],
"masterIdentifier":
{
- "system": "string",
- "value": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"subject":
{
- "reference": "string"
},
"type":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"class":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"author":
[
- {
  - "reference": "string"
  }
],
"custodian":
{
- "reference": "string"
},
"authenticator":
{
- "reference": "string"
},
"created": "string",
"indexed": "string",
"status": "string",
"docStatus":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"relatesTo":
[
- {
  - "code": "string",
  - "target":
    {
    "reference": "string"
    }
  }
],
"description": "string",
"securityLabel":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"content":
[
- {
  - "attachment":
    {
    "contentType": "string",
    "language": "string",
    "url": "string",
    "size": 0,
    "hash": "string"
    },
  - "format":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"context":
{
- "encounter":
  {
  - "reference": "string"
  },
- "event":
  [
  - {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    }
  ],
- "period":
  {
  - "start": "string",
  - "end": "string"
  },
- "facilityType":
  {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
  },
- "practiceSetting":
  {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
  },
- "sourcePatientInfo":
  {
  - "reference": "string"
  },
- "related":
  [
  - {
    "identifier":
    {
    "system": "string",
    "value": "string"
    },
    "ref":
    {
    "reference": "string"
    }
    }
  ]
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /DocumentReference/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/DocumentReference/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /DocumentReference/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/DocumentReference/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /DocumentReference/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/DocumentReference/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /DocumentReference/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/DocumentReference/{id}/_history/{vid}

EligibilityRequest

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
created required	string non-empty
targetReference required	object
organizationReference required	object
priority required	object
patientReference required	object
coverageReference required	object

Responses

200

Success

post /EligibilityRequest

https://dev-pineapple-fhir.azurehealthcareapis.com/EligibilityRequest

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"created": "string",
"targetReference":
{
- "reference": "string"
},
"organizationReference":
{
- "reference": "string"
},
"priority":
{
- "code": "string"
},
"patientReference":
{
- "reference": "string"
},
"coverageReference":
{
- "reference": "string"
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
created	string <date> The creation date for the EOB
enterer	string The party who is responsible for the request
facility	string Facility responsible for the goods and services
identifier	string The business identifier of the Eligibility
organization	string The reference to the providing organization
patient	string The reference to the patient
provider	string The reference to the provider
_format	string

Responses

200

Success

get /EligibilityRequest

https://dev-pineapple-fhir.azurehealthcareapis.com/EligibilityRequest

<no summary>

path Parameters

required

string

Responses

200

Success

get /EligibilityRequest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/EligibilityRequest/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
created required	string non-empty
targetReference required	object
organizationReference required	object
priority required	object
patientReference required	object
coverageReference required	object

Responses

200

Success

put /EligibilityRequest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/EligibilityRequest/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"created": "string",
"targetReference":
{
- "reference": "string"
},
"organizationReference":
{
- "reference": "string"
},
"priority":
{
- "code": "string"
},
"patientReference":
{
- "reference": "string"
},
"coverageReference":
{
- "reference": "string"
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /EligibilityRequest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/EligibilityRequest/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /EligibilityRequest/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/EligibilityRequest/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /EligibilityRequest/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/EligibilityRequest/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /EligibilityRequest/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/EligibilityRequest/{id}/_history/{vid}

EligibilityResponse

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
requestReference required	object
outcome required	string non-empty
disposition required	string non-empty
created required	string non-empty
organizationReference required	object
inforce required	boolean
_inforce required	object

Responses

200

Success

post /EligibilityResponse

https://dev-pineapple-fhir.azurehealthcareapis.com/EligibilityResponse

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"requestReference":
{
- "reference": "string"
},
"outcome": "string",
"disposition": "string",
"created": "string",
"organizationReference":
{
- "reference": "string"
},
"inforce": true,
"_inforce":
{
- "fhir_comments":
  [
  - { }
  ]
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
created	string <date> The creation date
disposition	string The contents of the disposition message
identifier	string The business identifier
insurer	string The organization which generated this resource
outcome	string The processing outcome
request-organization	string The EligibilityRequest organization
request-provider	string The EligibilityRequest provider
request	string The EligibilityRequest reference
_format	string

Responses

200

Success

get /EligibilityResponse

https://dev-pineapple-fhir.azurehealthcareapis.com/EligibilityResponse

<no summary>

path Parameters

required

string

Responses

200

Success

get /EligibilityResponse/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/EligibilityResponse/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
requestReference required	object
outcome required	string non-empty
disposition required	string non-empty
created required	string non-empty
organizationReference required	object
inforce required	boolean
_inforce required	object

Responses

200

Success

put /EligibilityResponse/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/EligibilityResponse/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"requestReference":
{
- "reference": "string"
},
"outcome": "string",
"disposition": "string",
"created": "string",
"organizationReference":
{
- "reference": "string"
},
"inforce": true,
"_inforce":
{
- "fhir_comments":
  [
  - { }
  ]
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /EligibilityResponse/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/EligibilityResponse/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /EligibilityResponse/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/EligibilityResponse/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /EligibilityResponse/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/EligibilityResponse/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /EligibilityResponse/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/EligibilityResponse/{id}/_history/{vid}

Encounter

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
status required	string non-empty
class required	string non-empty
patient required	object

Responses

200

Success

post /Encounter

https://dev-pineapple-fhir.azurehealthcareapis.com/Encounter

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"status": "string",
"class": "string",
"patient":
{
- "reference": "string"
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
appointment	string The appointment that scheduled this encounter
class	string inpatient \| outpatient \| ambulatory \| emergency +
date	string <date> A date within the period the Encounter lasted
diagnosis	string Reason the encounter takes place (resource)
episodeofcare	string Episode(s) of care that this encounter should be recorded against
identifier	string Identifier(s) by which this encounter is known
incomingreferral	string The ReferralRequest that initiated this encounter
length	number Length of encounter in days
location-period	string <date> Time period during which the patient was present at the location
location	string Location the encounter takes place
participant	string Persons involved in the encounter other than the patient
participant-type	string Role of participant in encounter
part-of	string Another Encounter this encounter is part of
patient	string The patient ro group present at the encounter
practitioner	string Persons involved in the encounter other than the patient
reason	string Reason the encounter takes place (code)
service-provider	string The custodian organization of this Encounter record
special-arrangement	string Wheelchair, translator, stretcher, etc.
status	string planned \| arrived \| triaged \| in-progress \| onleave \| finished \| cancelled +
subject	string The patient ro group present at the encounter
type	string Specific type of encounter
_format	string

Responses

200

Success

get /Encounter

https://dev-pineapple-fhir.azurehealthcareapis.com/Encounter

<no summary>

path Parameters

required

string

Responses

200

Success

get /Encounter/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Encounter/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
status required	string non-empty
class required	string non-empty
patient required	object

Responses

200

Success

put /Encounter/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Encounter/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"status": "string",
"class": "string",
"patient":
{
- "reference": "string"
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Encounter/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Encounter/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Encounter/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Encounter/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Encounter/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Encounter/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Encounter/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Encounter/{id}/_history/{vid}

Endpoint

<no summary>

Request Body schema: application/json

any (Endpoint)

Responses

200

Success

post /Endpoint

https://dev-pineapple-fhir.azurehealthcareapis.com/Endpoint

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
connection-type	string Protocol/Profile/Standard to be used with this endpoint connection
identifier	string Identifies this endpoint across multiple systems
name	string A name that this endpoint can be identified by
organization	string The organization that is managing the endpoint
payload-type	string The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
status	string The current status of the Endpoint (usually expected to be active)
_format	string

Responses

200

Success

get /Endpoint

https://dev-pineapple-fhir.azurehealthcareapis.com/Endpoint

<no summary>

path Parameters

required

string

Responses

200

Success

get /Endpoint/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Endpoint/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

any (Endpoint)

Responses

200

Success

put /Endpoint/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Endpoint/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Endpoint/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Endpoint/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Endpoint/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Endpoint/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Endpoint/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Endpoint/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Endpoint/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Endpoint/{id}/_history/{vid}

EnrollmentRequest

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
created required	string non-empty
organization required	object
subject required	object
coverage required	object
relationship required	object

Responses

200

Success

post /EnrollmentRequest

https://dev-pineapple-fhir.azurehealthcareapis.com/EnrollmentRequest

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"created": "string",
"organization":
{
- "reference": "string"
},
"subject":
{
- "reference": "string"
},
"coverage":
{
- "reference": "string"
},
"relationship":
{
- "code": "string"
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
identifier	string The business identifier of the Enrollment
organization	string The organization who generated this resource
patient	string The party to be enrolled
subject	string The party to be enrolled
_format	string

Responses

200

Success

get /EnrollmentRequest

https://dev-pineapple-fhir.azurehealthcareapis.com/EnrollmentRequest

<no summary>

path Parameters

required

string

Responses

200

Success

get /EnrollmentRequest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/EnrollmentRequest/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
created required	string non-empty
organization required	object
subject required	object
coverage required	object
relationship required	object

Responses

200

Success

put /EnrollmentRequest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/EnrollmentRequest/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"created": "string",
"organization":
{
- "reference": "string"
},
"subject":
{
- "reference": "string"
},
"coverage":
{
- "reference": "string"
},
"relationship":
{
- "code": "string"
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /EnrollmentRequest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/EnrollmentRequest/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /EnrollmentRequest/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/EnrollmentRequest/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /EnrollmentRequest/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/EnrollmentRequest/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /EnrollmentRequest/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/EnrollmentRequest/{id}/_history/{vid}

EnrollmentResponse

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
request required	object
outcome required	string non-empty
disposition required	string non-empty
created required	string non-empty
organization required	object
requestOrganization required	object

Responses

200

Success

post /EnrollmentResponse

https://dev-pineapple-fhir.azurehealthcareapis.com/EnrollmentResponse

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"request":
{
- "reference": "string"
},
"outcome": "string",
"disposition": "string",
"created": "string",
"organization":
{
- "reference": "string"
},
"requestOrganization":
{
- "reference": "string"
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
identifier	string The business identifier of the EnrollmentResponse
organization	string The organization who generated this resource
request	string The reference to the claim
_format	string

Responses

200

Success

get /EnrollmentResponse

https://dev-pineapple-fhir.azurehealthcareapis.com/EnrollmentResponse

<no summary>

path Parameters

required

string

Responses

200

Success

get /EnrollmentResponse/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/EnrollmentResponse/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
request required	object
outcome required	string non-empty
disposition required	string non-empty
created required	string non-empty
organization required	object
requestOrganization required	object

Responses

200

Success

put /EnrollmentResponse/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/EnrollmentResponse/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"request":
{
- "reference": "string"
},
"outcome": "string",
"disposition": "string",
"created": "string",
"organization":
{
- "reference": "string"
},
"requestOrganization":
{
- "reference": "string"
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /EnrollmentResponse/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/EnrollmentResponse/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /EnrollmentResponse/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/EnrollmentResponse/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /EnrollmentResponse/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/EnrollmentResponse/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /EnrollmentResponse/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/EnrollmentResponse/{id}/_history/{vid}

EpisodeOfCare

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
fhir_comments required	Array of objects
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
status required	string non-empty
statusHistory required	Array of objects non-empty
type required	Array of objects non-empty
condition required	Array of objects non-empty
patient required	object
managingOrganization required	object
period required	object
referralRequest required	Array of objects non-empty
careManager required	object

Responses

200

Success

post /EpisodeOfCare

https://dev-pineapple-fhir.azurehealthcareapis.com/EpisodeOfCare

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"fhir_comments":
[
- { }
],
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"status": "string",
"statusHistory":
[
- {
  - "status": "string",
  - "period":
    {
    "start": "string",
    "end": "string"
    }
  }
],
"type":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"condition":
[
- {
  - "reference": "string",
  - "display": "string"
  }
],
"patient":
{
- "reference": "string"
},
"managingOrganization":
{
- "reference": "string"
},
"period":
{
- "start": "string"
},
"referralRequest":
[
- {
  - "display": "string"
  }
],
"careManager":
{
- "reference": "string",
- "display": "string"
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
care-manager	string Care manager/care co-ordinator for the patient
condition	string Conditions/problems/diagnoses this episode of care is for
date	string <date> The provided date search value falls within the episode of care's period
identifier	string Business Identifier(s) relevant for this EpisodeOfCare
incomingreferral	string Incoming Referral Request
organization	string The organization that has assumed the specific responsibilities of this EpisodeOfCare
patient	string The patient who is the focus of this episode of care
status	string The current status of the Episode of Care as provided (does not check the status history collection)
type	string Type/class - e.g. specialist referral, disease management
_format	string

Responses

200

Success

get /EpisodeOfCare

https://dev-pineapple-fhir.azurehealthcareapis.com/EpisodeOfCare

<no summary>

path Parameters

required

string

Responses

200

Success

get /EpisodeOfCare/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/EpisodeOfCare/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
fhir_comments required	Array of objects
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
status required	string non-empty
statusHistory required	Array of objects non-empty
type required	Array of objects non-empty
condition required	Array of objects non-empty
patient required	object
managingOrganization required	object
period required	object
referralRequest required	Array of objects non-empty
careManager required	object

Responses

200

Success

put /EpisodeOfCare/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/EpisodeOfCare/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"fhir_comments":
[
- { }
],
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"status": "string",
"statusHistory":
[
- {
  - "status": "string",
  - "period":
    {
    "start": "string",
    "end": "string"
    }
  }
],
"type":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"condition":
[
- {
  - "reference": "string",
  - "display": "string"
  }
],
"patient":
{
- "reference": "string"
},
"managingOrganization":
{
- "reference": "string"
},
"period":
{
- "start": "string"
},
"referralRequest":
[
- {
  - "display": "string"
  }
],
"careManager":
{
- "reference": "string",
- "display": "string"
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /EpisodeOfCare/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/EpisodeOfCare/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /EpisodeOfCare/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/EpisodeOfCare/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /EpisodeOfCare/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/EpisodeOfCare/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /EpisodeOfCare/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/EpisodeOfCare/{id}/_history/{vid}

ExpansionProfile

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
status required	string non-empty
experimental required	boolean
excludeNested required	boolean

Responses

200

Success

post /ExpansionProfile

https://dev-pineapple-fhir.azurehealthcareapis.com/ExpansionProfile

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"status": "string",
"experimental": true,
"excludeNested": true

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
date	string <date> The expansion profile publication date
description	string The description of the expansion profile
identifier	string External identifier for the expansion profile
jurisdiction	string Intended jurisdiction for the expansion profile
name	string Computationally friendly name of the expansion profile
publisher	string Name of the publisher of the expansion profile
status	string The current status of the expansion profile
url	string The uri that identifies the expansion profile
version	string The business version of the expansion profile
_format	string

Responses

200

Success

get /ExpansionProfile

https://dev-pineapple-fhir.azurehealthcareapis.com/ExpansionProfile

<no summary>

path Parameters

required

string

Responses

200

Success

get /ExpansionProfile/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ExpansionProfile/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
status required	string non-empty
experimental required	boolean
excludeNested required	boolean

Responses

200

Success

put /ExpansionProfile/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ExpansionProfile/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"status": "string",
"experimental": true,
"excludeNested": true

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /ExpansionProfile/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ExpansionProfile/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /ExpansionProfile/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ExpansionProfile/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /ExpansionProfile/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ExpansionProfile/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /ExpansionProfile/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/ExpansionProfile/{id}/_history/{vid}

ExplanationOfBenefit

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
claimReference required	object
created required	string non-empty
_created required	object
disposition required	string non-empty
organizationReference required	object
patientReference required	object
coverage required	object
item required	Array of objects non-empty
totalCost required	object
totalBenefit required	object

Responses

200

Success

post /ExplanationOfBenefit

https://dev-pineapple-fhir.azurehealthcareapis.com/ExplanationOfBenefit

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"claimReference":
{
- "reference": "string"
},
"created": "string",
"_created":
{
- "fhir_comments":
  [
  - { }
  ]
},
"disposition": "string",
"organizationReference":
{
- "reference": "string"
},
"patientReference":
{
- "reference": "string"
},
"coverage":
{
- "coverageReference":
  {
  - "reference": "string"
  }
},
"item":
[
- {
  - "sequence": 0,
  - "type":
    {
    "code": "string"
    },
  - "providerReference":
    {
    "reference": "string"
    },
  - "service":
    {
    "system": "string",
    "code": "string"
    },
  - "servicedDate": "string",
  - "unitPrice":
    {
    "value": 0,
    "system": "string",
    "code": "string"
    },
  - "net":
    {
    "value": 0,
    "system": "string",
    "code": "string"
    },
  - "adjudication":
    [
    {
    "category":
    {
    "code": "string"
    },
    "amount":
    {
    "value": 0,
    "system": "string",
    "code": "string"
    }
    }
    ]
  }
],
"totalCost":
{
- "value": 0,
- "system": "string",
- "code": "string"
},
"totalBenefit":
{
- "value": 0,
- "system": "string",
- "code": "string"
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
care-team	string Member of the CareTeam
claim	string The reference to the claim
coverage	string The plan under which the claim was adjudicated
created	string <date> The creation date for the EOB
disposition	string The contents of the disposition message
encounter	string Encounters associated with a billed line item
enterer	string The party responsible for the entry of the Claim
facility	string Facility responsible for the goods and services
identifier	string The business identifier of the Explanation of Benefit
organization	string The reference to the providing organization
patient	string The reference to the patient
payee	string The party receiving any payment for the Claim
provider	string The reference to the provider
_format	string

Responses

200

Success

get /ExplanationOfBenefit

https://dev-pineapple-fhir.azurehealthcareapis.com/ExplanationOfBenefit

<no summary>

path Parameters

required

string

Responses

200

Success

get /ExplanationOfBenefit/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ExplanationOfBenefit/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
claimReference required	object
created required	string non-empty
_created required	object
disposition required	string non-empty
organizationReference required	object
patientReference required	object
coverage required	object
item required	Array of objects non-empty
totalCost required	object
totalBenefit required	object

Responses

200

Success

put /ExplanationOfBenefit/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ExplanationOfBenefit/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"claimReference":
{
- "reference": "string"
},
"created": "string",
"_created":
{
- "fhir_comments":
  [
  - { }
  ]
},
"disposition": "string",
"organizationReference":
{
- "reference": "string"
},
"patientReference":
{
- "reference": "string"
},
"coverage":
{
- "coverageReference":
  {
  - "reference": "string"
  }
},
"item":
[
- {
  - "sequence": 0,
  - "type":
    {
    "code": "string"
    },
  - "providerReference":
    {
    "reference": "string"
    },
  - "service":
    {
    "system": "string",
    "code": "string"
    },
  - "servicedDate": "string",
  - "unitPrice":
    {
    "value": 0,
    "system": "string",
    "code": "string"
    },
  - "net":
    {
    "value": 0,
    "system": "string",
    "code": "string"
    },
  - "adjudication":
    [
    {
    "category":
    {
    "code": "string"
    },
    "amount":
    {
    "value": 0,
    "system": "string",
    "code": "string"
    }
    }
    ]
  }
],
"totalCost":
{
- "value": 0,
- "system": "string",
- "code": "string"
},
"totalBenefit":
{
- "value": 0,
- "system": "string",
- "code": "string"
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /ExplanationOfBenefit/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ExplanationOfBenefit/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /ExplanationOfBenefit/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ExplanationOfBenefit/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /ExplanationOfBenefit/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ExplanationOfBenefit/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /ExplanationOfBenefit/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/ExplanationOfBenefit/{id}/_history/{vid}

FamilyMemberHistory

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
patient required	object
date required	string non-empty
status required	string non-empty
relationship required	object
condition required	Array of objects non-empty

Responses

200

Success

post /FamilyMemberHistory

https://dev-pineapple-fhir.azurehealthcareapis.com/FamilyMemberHistory

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"patient":
{
- "reference": "string",
- "display": "string"
},
"date": "string",
"status": "string",
"relationship":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string"
    }
  ]
},
"condition":
[
- {
  - "code":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ],
    "text": "string"
    },
  - "onsetQuantity":
    {
    "value": 0,
    "unit": "string",
    "system": "string"
    },
  - "note":
    {
    "text": "string"
    }
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
code	string A search by a condition code
date	string <date> When history was captured/updated
definition	string Instantiates protocol or definition
gender	string A search by a gender code of a family member
identifier	string A search by a record identifier
patient	string The identity of a subject to list family member history items for
relationship	string A search by a relationship type
status	string partial \| completed \| entered-in-error \| health-unknown
_format	string

Responses

200

Success

get /FamilyMemberHistory

https://dev-pineapple-fhir.azurehealthcareapis.com/FamilyMemberHistory

<no summary>

path Parameters

required

string

Responses

200

Success

get /FamilyMemberHistory/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/FamilyMemberHistory/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
patient required	object
date required	string non-empty
status required	string non-empty
relationship required	object
condition required	Array of objects non-empty

Responses

200

Success

put /FamilyMemberHistory/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/FamilyMemberHistory/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"patient":
{
- "reference": "string",
- "display": "string"
},
"date": "string",
"status": "string",
"relationship":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string"
    }
  ]
},
"condition":
[
- {
  - "code":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ],
    "text": "string"
    },
  - "onsetQuantity":
    {
    "value": 0,
    "unit": "string",
    "system": "string"
    },
  - "note":
    {
    "text": "string"
    }
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /FamilyMemberHistory/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/FamilyMemberHistory/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /FamilyMemberHistory/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/FamilyMemberHistory/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /FamilyMemberHistory/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/FamilyMemberHistory/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /FamilyMemberHistory/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/FamilyMemberHistory/{id}/_history/{vid}

Flag

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
category required	object
status required	string non-empty
subject required	object
author required	object
code required	object

Responses

200

Success

post /Flag

https://dev-pineapple-fhir.azurehealthcareapis.com/Flag

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"category":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ],
- "text": "string"
},
"status": "string",
"subject":
{
- "reference": "string",
- "display": "string"
},
"author":
{
- "reference": "string",
- "display": "string"
},
"code":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ],
- "text": "string"
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
author	string Flag creator
date	string <date> Time period when flag is active
encounter	string Alert relevant during encounter
identifier	string Business identifier
patient	string The identity of a subject to list flags for
subject	string The identity of a subject to list flags for
_format	string

Responses

200

Success

get /Flag

https://dev-pineapple-fhir.azurehealthcareapis.com/Flag

<no summary>

path Parameters

required

string

Responses

200

Success

get /Flag/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Flag/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
category required	object
status required	string non-empty
subject required	object
author required	object
code required	object

Responses

200

Success

put /Flag/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Flag/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"category":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ],
- "text": "string"
},
"status": "string",
"subject":
{
- "reference": "string",
- "display": "string"
},
"author":
{
- "reference": "string",
- "display": "string"
},
"code":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ],
- "text": "string"
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Flag/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Flag/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Flag/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Flag/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Flag/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Flag/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Flag/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Flag/{id}/_history/{vid}

Goal

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
extension required	Array of objects non-empty
subject required	object
description required	string non-empty
status required	string non-empty
addresses required	Array of objects non-empty

Responses

200

Success

post /Goal

https://dev-pineapple-fhir.azurehealthcareapis.com/Goal

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"extension":
[
- {
  - "extension":
    [
    {
    "url": "string",
    "valueCodeableConcept":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    }
    }
    ],
  - "url": "string"
  }
],
"subject":
{
- "reference": "string",
- "display": "string"
},
"description": "string",
"status": "string",
"addresses":
[
- {
  - "reference": "string",
  - "display": "string"
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
category	string E.g. Treatment, dietary, behavioral, etc.
identifier	string External Ids for this goal
patient	string Who this goal is intended for
start-date	string <date> When goal pursuit begins
status	string proposed \| accepted \| planned \| in-progress \| on-target \| ahead-of-target \| behind-target \| sustaining \| achieved \| on-hold \| cancelled \| entered-in-error \| rejected
subject	string Who this goal is intended for
target-date	string <date> Reach goal on or before
_format	string

Responses

200

Success

get /Goal

https://dev-pineapple-fhir.azurehealthcareapis.com/Goal

<no summary>

path Parameters

required

string

Responses

200

Success

get /Goal/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Goal/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
extension required	Array of objects non-empty
subject required	object
description required	string non-empty
status required	string non-empty
addresses required	Array of objects non-empty

Responses

200

Success

put /Goal/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Goal/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"extension":
[
- {
  - "extension":
    [
    {
    "url": "string",
    "valueCodeableConcept":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    }
    }
    ],
  - "url": "string"
  }
],
"subject":
{
- "reference": "string",
- "display": "string"
},
"description": "string",
"status": "string",
"addresses":
[
- {
  - "reference": "string",
  - "display": "string"
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Goal/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Goal/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Goal/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Goal/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Goal/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Goal/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Goal/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Goal/{id}/_history/{vid}

GraphDefinition

<no summary>

Request Body schema: application/json

any (GraphDefinition)

Responses

200

Success

post /GraphDefinition

https://dev-pineapple-fhir.azurehealthcareapis.com/GraphDefinition

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
date	string <date> The graph definition publication date
description	string The description of the graph definition
jurisdiction	string Intended jurisdiction for the graph definition
name	string Computationally friendly name of the graph definition
publisher	string Name of the publisher of the graph definition
start	string Type of resource at which the graph starts
status	string The current status of the graph definition
url	string The uri that identifies the graph definition
version	string The business version of the graph definition
_format	string

Responses

200

Success

get /GraphDefinition

https://dev-pineapple-fhir.azurehealthcareapis.com/GraphDefinition

<no summary>

path Parameters

required

string

Responses

200

Success

get /GraphDefinition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/GraphDefinition/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

any (GraphDefinition)

Responses

200

Success

put /GraphDefinition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/GraphDefinition/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

path Parameters

required

string

Responses

200

Success

delete /GraphDefinition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/GraphDefinition/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /GraphDefinition/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/GraphDefinition/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /GraphDefinition/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/GraphDefinition/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /GraphDefinition/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/GraphDefinition/{id}/_history/{vid}

Group

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
type required	string non-empty
actual required	boolean
code required	object
name required	string non-empty
quantity required	number
characteristic required	Array of objects non-empty

Responses

200

Success

post /Group

https://dev-pineapple-fhir.azurehealthcareapis.com/Group

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"type": "string",
"actual": true,
"code":
{
- "text": "string"
},
"name": "string",
"quantity": 0,
"characteristic":
[
- {
  - "code":
    {
    "text": "string"
    },
  - "valueCodeableConcept":
    {
    "text": "string"
    },
  - "exclude": true
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
actual	string Descriptive or actual
characteristic	string Kind of characteristic
characteristic-value	string A composite of both characteristic and value
code	string The kind of resources contained
exclude	string Group includes or excludes
identifier	string Unique id
member	string Reference to the group member
type	string The type of resources the group contains
value	string Value held by characteristic
_format	string

Responses

200

Success

get /Group

https://dev-pineapple-fhir.azurehealthcareapis.com/Group

<no summary>

path Parameters

required

string

Responses

200

Success

get /Group/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Group/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
type required	string non-empty
actual required	boolean
code required	object
name required	string non-empty
quantity required	number
characteristic required	Array of objects non-empty

Responses

200

Success

put /Group/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Group/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"type": "string",
"actual": true,
"code":
{
- "text": "string"
},
"name": "string",
"quantity": 0,
"characteristic":
[
- {
  - "code":
    {
    "text": "string"
    },
  - "valueCodeableConcept":
    {
    "text": "string"
    },
  - "exclude": true
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Group/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Group/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Group/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Group/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Group/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Group/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Group/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Group/{id}/_history/{vid}

GuidanceResponse

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
module required	object
status required	string non-empty

Responses

200

Success

post /GuidanceResponse

https://dev-pineapple-fhir.azurehealthcareapis.com/GuidanceResponse

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"module":
{
- "reference": "string"
},
"status": "string"

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
identifier	string The identifier of the guidance response
patient	string The identity of a patient to search for guidance response results
request	string The identifier of the request associated with the response
subject	string The subject that the guidance response is about
_format	string

Responses

200

Success

get /GuidanceResponse

https://dev-pineapple-fhir.azurehealthcareapis.com/GuidanceResponse

<no summary>

path Parameters

required

string

Responses

200

Success

get /GuidanceResponse/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/GuidanceResponse/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
module required	object
status required	string non-empty

Responses

200

Success

put /GuidanceResponse/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/GuidanceResponse/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"module":
{
- "reference": "string"
},
"status": "string"

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /GuidanceResponse/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/GuidanceResponse/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /GuidanceResponse/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/GuidanceResponse/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /GuidanceResponse/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/GuidanceResponse/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /GuidanceResponse/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/GuidanceResponse/{id}/_history/{vid}

HealthcareService

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
contained required	Array of objects non-empty
serviceType required	Array of objects non-empty
specialty required	Array of objects non-empty
location required	Array of objects non-empty
serviceName required	string non-empty
comment required	string non-empty
extraDetails required	string non-empty
telecom required	Array of objects non-empty
coverageArea required	Array of objects non-empty
eligibility required	object
eligibilityNote required	string non-empty
programName required	Array of objects
characteristic required	Array of objects non-empty
referralMethod required	Array of objects non-empty
publicKey required	string non-empty
appointmentRequired required	boolean
availableTime required	Array of objects non-empty
notAvailable required	Array of objects non-empty
availabilityExceptions required	string non-empty

Responses

200

Success

post /HealthcareService

https://dev-pineapple-fhir.azurehealthcareapis.com/HealthcareService

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"contained":
[
- {
  - "resourceType": "string",
  - "id": "string",
  - "description": "string",
  - "mode": "string",
  - "physicalType":
    {
    "coding":
    [
    {
    "code": "string",
    "display": "string"
    }
    ]
    }
  }
],
"serviceType":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"specialty":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"location":
[
- {
  - "reference": "string"
  }
],
"serviceName": "string",
"comment": "string",
"extraDetails": "string",
"telecom":
[
- {
  - "system": "string",
  - "value": "string",
  - "use": "string"
  }
],
"coverageArea":
[
- {
  - "reference": "string",
  - "display": "string"
  }
],
"eligibility":
{
- "coding":
  [
  - {
    "display": "string"
    }
  ]
},
"eligibilityNote": "string",
"programName":
[
- { }
],
"characteristic":
[
- {
  - "coding":
    [
    {
    "display": "string"
    }
    ]
  }
],
"referralMethod":
[
- {
  - "coding":
    [
    {
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"publicKey": "string",
"appointmentRequired": true,
"availableTime":
[
- {
  - "daysOfWeek":
    [
    { }
    ],
  - "availableStartTime": "string",
  - "availableEndTime": "string"
  }
],
"notAvailable":
[
- {
  - "description": "string",
  - "during":
    {
    "start": "string",
    "end": "string"
    }
  }
],
"availabilityExceptions": "string"

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
active	string The Healthcare Service is currently marked as active
category	string Service Category of the Healthcare Service
characteristic	string One of the HealthcareService's characteristics
endpoint	string Technical endpoints providing access to services operated for the location
identifier	string External identifiers for this item
location	string The location of the Healthcare Service
name	string A portion of the Healthcare service name
organization	string The organization that provides this Healthcare Service
programname	string One of the Program Names serviced by this HealthcareService
type	string The type of service provided by this healthcare service
_format	string

Responses

200

Success

get /HealthcareService

https://dev-pineapple-fhir.azurehealthcareapis.com/HealthcareService

<no summary>

path Parameters

required

string

Responses

200

Success

get /HealthcareService/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/HealthcareService/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
contained required	Array of objects non-empty
serviceType required	Array of objects non-empty
specialty required	Array of objects non-empty
location required	Array of objects non-empty
serviceName required	string non-empty
comment required	string non-empty
extraDetails required	string non-empty
telecom required	Array of objects non-empty
coverageArea required	Array of objects non-empty
eligibility required	object
eligibilityNote required	string non-empty
programName required	Array of objects
characteristic required	Array of objects non-empty
referralMethod required	Array of objects non-empty
publicKey required	string non-empty
appointmentRequired required	boolean
availableTime required	Array of objects non-empty
notAvailable required	Array of objects non-empty
availabilityExceptions required	string non-empty

Responses

200

Success

put /HealthcareService/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/HealthcareService/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"contained":
[
- {
  - "resourceType": "string",
  - "id": "string",
  - "description": "string",
  - "mode": "string",
  - "physicalType":
    {
    "coding":
    [
    {
    "code": "string",
    "display": "string"
    }
    ]
    }
  }
],
"serviceType":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"specialty":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"location":
[
- {
  - "reference": "string"
  }
],
"serviceName": "string",
"comment": "string",
"extraDetails": "string",
"telecom":
[
- {
  - "system": "string",
  - "value": "string",
  - "use": "string"
  }
],
"coverageArea":
[
- {
  - "reference": "string",
  - "display": "string"
  }
],
"eligibility":
{
- "coding":
  [
  - {
    "display": "string"
    }
  ]
},
"eligibilityNote": "string",
"programName":
[
- { }
],
"characteristic":
[
- {
  - "coding":
    [
    {
    "display": "string"
    }
    ]
  }
],
"referralMethod":
[
- {
  - "coding":
    [
    {
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"publicKey": "string",
"appointmentRequired": true,
"availableTime":
[
- {
  - "daysOfWeek":
    [
    { }
    ],
  - "availableStartTime": "string",
  - "availableEndTime": "string"
  }
],
"notAvailable":
[
- {
  - "description": "string",
  - "during":
    {
    "start": "string",
    "end": "string"
    }
  }
],
"availabilityExceptions": "string"

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /HealthcareService/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/HealthcareService/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /HealthcareService/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/HealthcareService/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /HealthcareService/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/HealthcareService/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /HealthcareService/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/HealthcareService/{id}/_history/{vid}

ImagingManifest

<no summary>

Request Body schema: application/json

any (ImagingManifest)

Responses

200

Success

post /ImagingManifest

https://dev-pineapple-fhir.azurehealthcareapis.com/ImagingManifest

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
authoring-time	string <date> Time of the ImagingManifest (or a DICOM Key Object Selection which it represents) authoring
author	string Author of the ImagingManifest (or a DICOM Key Object Selection which it represents)
endpoint	string The endpoint for the study or series
identifier	string UID of the ImagingManifest (or a DICOM Key Object Selection which it represents)
imaging-study	string ImagingStudy resource selected in the ImagingManifest (or a DICOM Key Object Selection which it represents)
patient	string Subject of the ImagingManifest (or a DICOM Key Object Selection which it represents)
selected-study	string Study selected in the ImagingManifest (or a DICOM Key Object Selection which it represents)
_format	string

Responses

200

Success

get /ImagingManifest

https://dev-pineapple-fhir.azurehealthcareapis.com/ImagingManifest

<no summary>

path Parameters

required

string

Responses

200

Success

get /ImagingManifest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ImagingManifest/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

any (ImagingManifest)

Responses

200

Success

put /ImagingManifest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ImagingManifest/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

path Parameters

required

string

Responses

200

Success

delete /ImagingManifest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ImagingManifest/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /ImagingManifest/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ImagingManifest/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /ImagingManifest/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ImagingManifest/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /ImagingManifest/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/ImagingManifest/{id}/_history/{vid}

ImagingStudy

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
uid required	string non-empty
patient required	object
started required	string non-empty
numberOfSeries required	number
numberOfInstances required	number
series required	Array of objects non-empty

Responses

200

Success

post /ImagingStudy

https://dev-pineapple-fhir.azurehealthcareapis.com/ImagingStudy

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"uid": "string",
"patient":
{
- "reference": "string"
},
"started": "string",
"numberOfSeries": 0,
"numberOfInstances": 0,
"series":
[
- {
  - "uid": "string",
  - "number": 0,
  - "modality":
    {
    "system": "string",
    "code": "string"
    },
  - "description": "string",
  - "numberOfInstances": 0,
  - "bodySite":
    {
    "system": "string",
    "_system":
    {
    "fhir_comments":
    [
    { }
    ]
    },
    "code": "string",
    "display": "string"
    },
  - "instance":
    [
    {
    "uid": "string",
    "number": 0,
    "sopClass": "string",
    "content":
    [
    {
    "url": "string"
    }
    ]
    }
    ]
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
accession	string The accession identifier for the study
basedon	string The order for the image
bodysite	string The body site studied
context	string The context of the study
dicom-class	string The type of the instance
endpoint	string The endpoint for te study or series
identifier	string Other identifiers for the Study
modality	string The modality of the series
patient	string Who the study is about
performer	string The person who performed the study
reason	string The reason for the study
series	string The identifier of the series of images
started	string <date> When the study was started
study	string The study identifier for the image
uid	string The instance unique identifier
_format	string

Responses

200

Success

get /ImagingStudy

https://dev-pineapple-fhir.azurehealthcareapis.com/ImagingStudy

<no summary>

path Parameters

required

string

Responses

200

Success

get /ImagingStudy/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ImagingStudy/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
uid required	string non-empty
patient required	object
started required	string non-empty
numberOfSeries required	number
numberOfInstances required	number
series required	Array of objects non-empty

Responses

200

Success

put /ImagingStudy/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ImagingStudy/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"uid": "string",
"patient":
{
- "reference": "string"
},
"started": "string",
"numberOfSeries": 0,
"numberOfInstances": 0,
"series":
[
- {
  - "uid": "string",
  - "number": 0,
  - "modality":
    {
    "system": "string",
    "code": "string"
    },
  - "description": "string",
  - "numberOfInstances": 0,
  - "bodySite":
    {
    "system": "string",
    "_system":
    {
    "fhir_comments":
    [
    { }
    ]
    },
    "code": "string",
    "display": "string"
    },
  - "instance":
    [
    {
    "uid": "string",
    "number": 0,
    "sopClass": "string",
    "content":
    [
    {
    "url": "string"
    }
    ]
    }
    ]
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /ImagingStudy/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ImagingStudy/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /ImagingStudy/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ImagingStudy/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /ImagingStudy/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ImagingStudy/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /ImagingStudy/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/ImagingStudy/{id}/_history/{vid}

Immunization

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
status required	string non-empty
date required	string non-empty
vaccineCode required	object
patient required	object
wasNotGiven required	boolean
reported required	boolean
performer required	object
requester required	object
encounter required	object
manufacturer required	object
location required	object
lotNumber required	string non-empty
expirationDate required	string non-empty
site required	object
route required	object
doseQuantity required	object
note required	Array of objects non-empty
explanation required	object
reaction required	Array of objects non-empty
vaccinationProtocol required	Array of objects non-empty

Responses

200

Success

post /Immunization

https://dev-pineapple-fhir.azurehealthcareapis.com/Immunization

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"status": "string",
"date": "string",
"vaccineCode":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string"
    }
  ],
- "text": "string"
},
"patient":
{
- "reference": "string"
},
"wasNotGiven": true,
"reported": true,
"performer":
{
- "reference": "string"
},
"requester":
{
- "reference": "string"
},
"encounter":
{
- "reference": "string"
},
"manufacturer":
{
- "reference": "string"
},
"location":
{
- "reference": "string"
},
"lotNumber": "string",
"expirationDate": "string",
"site":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"route":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"doseQuantity":
{
- "value": 0,
- "system": "string",
- "code": "string"
},
"note":
[
- {
  - "text": "string"
  }
],
"explanation":
{
- "reason":
  [
  - {
    "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
    }
  ]
},
"reaction":
[
- {
  - "date": "string",
  - "detail":
    {
    "reference": "string"
    },
  - "reported": true
  }
],
"vaccinationProtocol":
[
- {
  - "doseSequence": 0,
  - "description": "string",
  - "authority":
    {
    "reference": "string"
    },
  - "series": "string",
  - "seriesDoses": 0,
  - "targetDisease":
    [
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
    }
    ],
  - "doseStatus":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    },
  - "doseStatusReason":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    }
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
date	string <date> Vaccination (non)-Administration Date
dose-sequence	number Dose number within series
identifier	string Business identifier
location	string The service delivery location or facility in which the vaccine was / was to be administered
lot-number	string Vaccine Lot Number
manufacturer	string Vaccine Manufacturer
notgiven	string Administrations which were not given
patient	string The patient for the vaccination record
practitioner	string The practitioner who played a role in the vaccination
reaction-date	string <date> When reaction started
reaction	string Additional information on reaction
reason-not-given	string Explanation of reason vaccination was not administered
reason	string Why immunization occurred
status	string Immunization event status
vaccine-code	string Vaccine Product Administered
_format	string

Responses

200

Success

get /Immunization

https://dev-pineapple-fhir.azurehealthcareapis.com/Immunization

<no summary>

path Parameters

required

string

Responses

200

Success

get /Immunization/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Immunization/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
status required	string non-empty
date required	string non-empty
vaccineCode required	object
patient required	object
wasNotGiven required	boolean
reported required	boolean
performer required	object
requester required	object
encounter required	object
manufacturer required	object
location required	object
lotNumber required	string non-empty
expirationDate required	string non-empty
site required	object
route required	object
doseQuantity required	object
note required	Array of objects non-empty
explanation required	object
reaction required	Array of objects non-empty
vaccinationProtocol required	Array of objects non-empty

Responses

200

Success

put /Immunization/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Immunization/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"status": "string",
"date": "string",
"vaccineCode":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string"
    }
  ],
- "text": "string"
},
"patient":
{
- "reference": "string"
},
"wasNotGiven": true,
"reported": true,
"performer":
{
- "reference": "string"
},
"requester":
{
- "reference": "string"
},
"encounter":
{
- "reference": "string"
},
"manufacturer":
{
- "reference": "string"
},
"location":
{
- "reference": "string"
},
"lotNumber": "string",
"expirationDate": "string",
"site":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"route":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"doseQuantity":
{
- "value": 0,
- "system": "string",
- "code": "string"
},
"note":
[
- {
  - "text": "string"
  }
],
"explanation":
{
- "reason":
  [
  - {
    "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
    }
  ]
},
"reaction":
[
- {
  - "date": "string",
  - "detail":
    {
    "reference": "string"
    },
  - "reported": true
  }
],
"vaccinationProtocol":
[
- {
  - "doseSequence": 0,
  - "description": "string",
  - "authority":
    {
    "reference": "string"
    },
  - "series": "string",
  - "seriesDoses": 0,
  - "targetDisease":
    [
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
    }
    ],
  - "doseStatus":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    },
  - "doseStatusReason":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    }
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Immunization/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Immunization/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Immunization/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Immunization/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Immunization/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Immunization/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Immunization/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Immunization/{id}/_history/{vid}

ImmunizationRecommendation

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
patient required	object
recommendation required	Array of objects non-empty

Responses

200

Success

post /ImmunizationRecommendation

https://dev-pineapple-fhir.azurehealthcareapis.com/ImmunizationRecommendation

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"patient":
{
- "reference": "string"
},
"recommendation":
[
- {
  - "date": "string",
  - "vaccineCode":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    },
  - "doseNumber": 0,
  - "forecastStatus":
    {
    "text": "string"
    },
  - "dateCriterion":
    [
    {
    "code":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    },
    "value": "string"
    }
    ],
  - "protocol":
    {
    "doseSequence": 0,
    "description": "string",
    "authority":
    {
    "reference": "string"
    },
    "series": "string"
    },
  - "supportingImmunization":
    [
    {
    "reference": "string"
    }
    ],
  - "supportingPatientInformation":
    [
    {
    "reference": "string"
    }
    ]
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
date	string <date> Date recommendation created
dose-number	number Recommended dose number
dose-sequence	number Dose number within sequence
identifier	string Business identifier
information	string Patient observations supporting recommendation
patient	string Who this profile is for
status	string Vaccine administration status
support	string Past immunizations supporting recommendation
target-disease	string Disease to be immunized against
vaccine-type	string Vaccine recommendation applies to
_format	string

Responses

200

Success

get /ImmunizationRecommendation

https://dev-pineapple-fhir.azurehealthcareapis.com/ImmunizationRecommendation

<no summary>

path Parameters

required

string

Responses

200

Success

get /ImmunizationRecommendation/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ImmunizationRecommendation/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
patient required	object
recommendation required	Array of objects non-empty

Responses

200

Success

put /ImmunizationRecommendation/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ImmunizationRecommendation/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"patient":
{
- "reference": "string"
},
"recommendation":
[
- {
  - "date": "string",
  - "vaccineCode":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    },
  - "doseNumber": 0,
  - "forecastStatus":
    {
    "text": "string"
    },
  - "dateCriterion":
    [
    {
    "code":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    },
    "value": "string"
    }
    ],
  - "protocol":
    {
    "doseSequence": 0,
    "description": "string",
    "authority":
    {
    "reference": "string"
    },
    "series": "string"
    },
  - "supportingImmunization":
    [
    {
    "reference": "string"
    }
    ],
  - "supportingPatientInformation":
    [
    {
    "reference": "string"
    }
    ]
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /ImmunizationRecommendation/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ImmunizationRecommendation/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /ImmunizationRecommendation/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ImmunizationRecommendation/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /ImmunizationRecommendation/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ImmunizationRecommendation/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /ImmunizationRecommendation/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/ImmunizationRecommendation/{id}/_history/{vid}

ImplementationGuide

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
url required	string non-empty
version required	string non-empty
name required	string non-empty
status required	string non-empty
experimental required	boolean
publisher required	string non-empty
contact required	Array of objects non-empty
date required	string non-empty
description required	string non-empty
useContext required	Array of objects non-empty
copyright required	string non-empty
fhirVersion required	string non-empty
dependency required	Array of objects non-empty
package required	Array of objects non-empty
global required	Array of objects non-empty
binary required	Array of objects
_binary required	Array of objects non-empty
page required	object

Responses

200

Success

post /ImplementationGuide

https://dev-pineapple-fhir.azurehealthcareapis.com/ImplementationGuide

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"url": "string",
"version": "string",
"name": "string",
"status": "string",
"experimental": true,
"publisher": "string",
"contact":
[
- {
  - "name": "string",
  - "telecom":
    [
    {
    "system": "string",
    "value": "string"
    }
    ]
  }
],
"date": "string",
"description": "string",
"useContext":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
  }
],
"copyright": "string",
"fhirVersion": "string",
"dependency":
[
- {
  - "type": "string",
  - "uri": "string",
  - "_uri":
    {
    "fhir_comments":
    [
    { }
    ]
    }
  }
],
"package":
[
- {
  - "name": "string",
  - "description": "string",
  - "resource":
    [
    {
    "example": true,
    "name": "string",
    "description": "string",
    "acronym": "string",
    "_acronym":
    {
    "fhir_comments":
    [
    { }
    ]
    },
    "sourceUri": "string",
    "exampleFor":
    {
    "reference": "string"
    }
    }
    ]
  }
],
"global":
[
- {
  - "type": "string",
  - "_type":
    {
    "fhir_comments":
    [
    { }
    ]
    },
  - "profile":
    {
    "reference": "string"
    }
  }
],
"binary":
[
- { }
],
"_binary":
[
- {
  - "fhir_comments":
    [
    { }
    ]
  }
],
"page":
{
- "source": "string",
- "name": "string",
- "kind": "string",
- "page":
  [
  - {
    "source": "string",
    "name": "string",
    "kind": "string",
    "type":
    [
    { }
    ],
    "package":
    [
    { }
    ],
    "format": "string"
    }
  ]
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
date	string <date> The implementation guide publication date
dependency	string Where to find dependency
description	string The description of the implementation guide
experimental	string For testing purposes, not real usage
jurisdiction	string Intended jurisdiction for the implementation guide
name	string Computationally friendly name of the implementation guide
publisher	string Name of the publisher of the implementation guide
resource	string Location of the resource
status	string The current status of the implementation guide
url	string The uri that identifies the implementation guide
version	string The business version of the implementation guide
_format	string

Responses

200

Success

get /ImplementationGuide

https://dev-pineapple-fhir.azurehealthcareapis.com/ImplementationGuide

<no summary>

path Parameters

required

string

Responses

200

Success

get /ImplementationGuide/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ImplementationGuide/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
url required	string non-empty
version required	string non-empty
name required	string non-empty
status required	string non-empty
experimental required	boolean
publisher required	string non-empty
contact required	Array of objects non-empty
date required	string non-empty
description required	string non-empty
useContext required	Array of objects non-empty
copyright required	string non-empty
fhirVersion required	string non-empty
dependency required	Array of objects non-empty
package required	Array of objects non-empty
global required	Array of objects non-empty
binary required	Array of objects
_binary required	Array of objects non-empty
page required	object

Responses

200

Success

put /ImplementationGuide/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ImplementationGuide/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"url": "string",
"version": "string",
"name": "string",
"status": "string",
"experimental": true,
"publisher": "string",
"contact":
[
- {
  - "name": "string",
  - "telecom":
    [
    {
    "system": "string",
    "value": "string"
    }
    ]
  }
],
"date": "string",
"description": "string",
"useContext":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
  }
],
"copyright": "string",
"fhirVersion": "string",
"dependency":
[
- {
  - "type": "string",
  - "uri": "string",
  - "_uri":
    {
    "fhir_comments":
    [
    { }
    ]
    }
  }
],
"package":
[
- {
  - "name": "string",
  - "description": "string",
  - "resource":
    [
    {
    "example": true,
    "name": "string",
    "description": "string",
    "acronym": "string",
    "_acronym":
    {
    "fhir_comments":
    [
    { }
    ]
    },
    "sourceUri": "string",
    "exampleFor":
    {
    "reference": "string"
    }
    }
    ]
  }
],
"global":
[
- {
  - "type": "string",
  - "_type":
    {
    "fhir_comments":
    [
    { }
    ]
    },
  - "profile":
    {
    "reference": "string"
    }
  }
],
"binary":
[
- { }
],
"_binary":
[
- {
  - "fhir_comments":
    [
    { }
    ]
  }
],
"page":
{
- "source": "string",
- "name": "string",
- "kind": "string",
- "page":
  [
  - {
    "source": "string",
    "name": "string",
    "kind": "string",
    "type":
    [
    { }
    ],
    "package":
    [
    { }
    ],
    "format": "string"
    }
  ]
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /ImplementationGuide/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ImplementationGuide/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /ImplementationGuide/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ImplementationGuide/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /ImplementationGuide/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ImplementationGuide/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /ImplementationGuide/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/ImplementationGuide/{id}/_history/{vid}

Library

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
moduleMetadata required	object
model required	Array of objects non-empty
valueSet required	Array of objects non-empty
dataRequirement required	Array of objects non-empty
document required	object

Responses

200

Success

post /Library

https://dev-pineapple-fhir.azurehealthcareapis.com/Library

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"moduleMetadata":
{
- "identifier":
  [
  - {
    "use": "string",
    "value": "string"
    }
  ],
- "version": "string",
- "title": "string",
- "type": "string",
- "status": "string",
- "description": "string",
- "publicationDate": "string",
- "topic":
  [
  - {
    "text": "string"
    }
  ]
},
"model":
[
- {
  - "identifier": "string"
  }
],
"valueSet":
[
- {
  - "name": "string",
  - "identifier": "string"
  }
],
"dataRequirement":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "type": "string",
  - "codeFilter":
    [
    {
    "path": "string",
    "valueSetString": "string"
    }
    ]
  }
],
"document":
{
- "fhir_comments":
  [
  - { }
  ],
- "contentType": "string",
- "url": "string"
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
composed-of	string What resource is being referenced
date	string <date> The library publication date
depends-on	string What resource is being referenced
derived-from	string What resource is being referenced
description	string The description of the library
effective	string <date> The time during which the library is intended to be in use
identifier	string External identifier for the library
jurisdiction	string Intended jurisdiction for the library
name	string Computationally friendly name of the library
predecessor	string What resource is being referenced
publisher	string Name of the publisher of the library
status	string The current status of the library
successor	string What resource is being referenced
title	string The human-friendly name of the library
topic	string Topics associated with the module
url	string The uri that identifies the library
version	string The business version of the library
_format	string

Responses

200

Success

get /Library

https://dev-pineapple-fhir.azurehealthcareapis.com/Library

<no summary>

path Parameters

required

string

Responses

200

Success

get /Library/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Library/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
moduleMetadata required	object
model required	Array of objects non-empty
valueSet required	Array of objects non-empty
dataRequirement required	Array of objects non-empty
document required	object

Responses

200

Success

put /Library/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Library/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"moduleMetadata":
{
- "identifier":
  [
  - {
    "use": "string",
    "value": "string"
    }
  ],
- "version": "string",
- "title": "string",
- "type": "string",
- "status": "string",
- "description": "string",
- "publicationDate": "string",
- "topic":
  [
  - {
    "text": "string"
    }
  ]
},
"model":
[
- {
  - "identifier": "string"
  }
],
"valueSet":
[
- {
  - "name": "string",
  - "identifier": "string"
  }
],
"dataRequirement":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "type": "string",
  - "codeFilter":
    [
    {
    "path": "string",
    "valueSetString": "string"
    }
    ]
  }
],
"document":
{
- "fhir_comments":
  [
  - { }
  ],
- "contentType": "string",
- "url": "string"
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Library/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Library/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Library/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Library/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Library/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Library/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Library/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Library/{id}/_history/{vid}

Linkage

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
item required	Array of objects non-empty

Responses

200

Success

post /Linkage

https://dev-pineapple-fhir.azurehealthcareapis.com/Linkage

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"item":
[
- {
  - "type": "string",
  - "resource":
    {
    "reference": "string",
    "display": "string"
    }
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
author	string Author of the Linkage
item	string Matches on any item in the Linkage
source	string Matches on any item in the Linkage with a type of 'source'
_format	string

Responses

200

Success

get /Linkage

https://dev-pineapple-fhir.azurehealthcareapis.com/Linkage

<no summary>

path Parameters

required

string

Responses

200

Success

get /Linkage/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Linkage/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
item required	Array of objects non-empty

Responses

200

Success

put /Linkage/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Linkage/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"item":
[
- {
  - "type": "string",
  - "resource":
    {
    "reference": "string",
    "display": "string"
    }
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Linkage/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Linkage/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Linkage/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Linkage/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Linkage/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Linkage/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Linkage/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Linkage/{id}/_history/{vid}

List

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
status required	string non-empty
mode required	string non-empty
subject required	object
encounter required	object
date required	string non-empty
source required	object
entry required	Array of objects non-empty

Responses

200

Success

post /List

https://dev-pineapple-fhir.azurehealthcareapis.com/List

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"status": "string",
"mode": "string",
"subject":
{
- "fhir_comments":
  [
  - { }
  ],
- "reference": "string"
},
"encounter":
{
- "reference": "string"
},
"date": "string",
"source":
{
- "reference": "string"
},
"entry":
[
- {
  - "flag":
    {
    "text": "string"
    },
  - "deleted": true,
  - "item":
    {
    "reference": "string"
    }
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
code	string What the purpose of this list is
date	string <date> When the list was prepared
empty-reason	string Why list is empty
encounter	string Context in which list created
identifier	string Business identifier
item	string Actual entry
notes	string The annotation - text content
patient	string If all resources have the same subject
source	string Who and/or what defined the list contents (aka Author)
status	string current \| retired \| entered-in-error
subject	string If all resources have the same subject
title	string Descriptive name for the list
_format	string

Responses

200

Success

get /List

https://dev-pineapple-fhir.azurehealthcareapis.com/List

<no summary>

path Parameters

required

string

Responses

200

Success

get /List/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/List/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
status required	string non-empty
mode required	string non-empty
subject required	object
encounter required	object
date required	string non-empty
source required	object
entry required	Array of objects non-empty

Responses

200

Success

put /List/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/List/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"status": "string",
"mode": "string",
"subject":
{
- "fhir_comments":
  [
  - { }
  ],
- "reference": "string"
},
"encounter":
{
- "reference": "string"
},
"date": "string",
"source":
{
- "reference": "string"
},
"entry":
[
- {
  - "flag":
    {
    "text": "string"
    },
  - "deleted": true,
  - "item":
    {
    "reference": "string"
    }
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /List/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/List/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /List/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/List/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /List/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/List/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /List/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/List/{id}/_history/{vid}

Location

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
extension required	Array of objects non-empty
identifier required	Array of objects non-empty
status required	string non-empty
name required	string non-empty
description required	string non-empty
mode required	string non-empty
telecom required	Array of objects non-empty
address required	object
physicalType required	object
position required	object
managingOrganization required	object

Responses

200

Success

post /Location

https://dev-pineapple-fhir.azurehealthcareapis.com/Location

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"extension":
[
- {
  - "url": "string",
  - "valueString": "string"
  }
],
"identifier":
[
- {
  - "value": "string"
  }
],
"status": "string",
"name": "string",
"description": "string",
"mode": "string",
"telecom":
[
- {
  - "system": "string",
  - "value": "string",
  - "use": "string"
  }
],
"address":
{
- "use": "string",
- "line":
  [
  - { }
  ],
- "city": "string",
- "postalCode": "string",
- "country": "string"
},
"physicalType":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"position":
{
- "longitude": 0,
- "latitude": 0,
- "altitude": 0
},
"managingOrganization":
{
- "reference": "string"
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
address-city	string A city specified in an address
address-country	string A country/region specified in an address
address-postalcode	string A postal code specified in an address
address-state	string A state specified in an address
address	string A (part of the) address of the location
address-use	string A use code specified in an address
endpoint	string Technical endpoints providing access to services operated for the location
identifier	string An identifier for the location
name	string A portion of the location's name or alias
near-distance	integer A distance quantity to limit the near search to locations within a specific distance Requires the near parameter to also be included
near	string "The coordinates expressed as [latitude]:[longitude] (using the WGS84 datum, see notes) to find locations near to (servers may search using a square rather than a circle for efficiency) Requires the near parameter to also be included
operational-status	string Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping)
organization	string Searches for locations that are managed by the provided organization
partof	string A location of which this location is a part
status	string Searches for locations with a specific kind of status
type	string A code for the type of location
_format	string

Responses

200

Success

get /Location

https://dev-pineapple-fhir.azurehealthcareapis.com/Location

<no summary>

path Parameters

required

string

Responses

200

Success

get /Location/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Location/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
extension required	Array of objects non-empty
identifier required	Array of objects non-empty
status required	string non-empty
name required	string non-empty
description required	string non-empty
mode required	string non-empty
telecom required	Array of objects non-empty
address required	object
physicalType required	object
position required	object
managingOrganization required	object

Responses

200

Success

put /Location/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Location/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"extension":
[
- {
  - "url": "string",
  - "valueString": "string"
  }
],
"identifier":
[
- {
  - "value": "string"
  }
],
"status": "string",
"name": "string",
"description": "string",
"mode": "string",
"telecom":
[
- {
  - "system": "string",
  - "value": "string",
  - "use": "string"
  }
],
"address":
{
- "use": "string",
- "line":
  [
  - { }
  ],
- "city": "string",
- "postalCode": "string",
- "country": "string"
},
"physicalType":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"position":
{
- "longitude": 0,
- "latitude": 0,
- "altitude": 0
},
"managingOrganization":
{
- "reference": "string"
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Location/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Location/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Location/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Location/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Location/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Location/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Location/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Location/{id}/_history/{vid}

Measure

<no summary>

Request Body schema: application/json

any (Measure)

Responses

200

Success

post /Measure

https://dev-pineapple-fhir.azurehealthcareapis.com/Measure

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
composed-of	string What resource is being referenced
date	string <date> The measure publication date
depends-on	string What resource is being referenced
derived-from	string What resource is being referenced
description	string The description of the measure
effective	string <date> The time during which the measure is intended to be in use
identifier	string External identifier for the measure
jurisdiction	string Intended jurisdiction for the measure
name	string Computationally friendly name of the measure
predecessor	string What resource is being referenced
publisher	string Name of the publisher of the measure
status	string The current status of the measure
successor	string What resource is being referenced
title	string The human-friendly name of the measure
topic	string Topics associated with the module
url	string The uri that identifies the measure
version	string The business version of the measure
_format	string

Responses

200

Success

get /Measure

https://dev-pineapple-fhir.azurehealthcareapis.com/Measure

<no summary>

path Parameters

required

string

Responses

200

Success

get /Measure/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Measure/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

any (Measure)

Responses

200

Success

put /Measure/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Measure/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Measure/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Measure/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Measure/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Measure/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Measure/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Measure/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Measure/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Measure/{id}/_history/{vid}

MeasureReport

<no summary>

Request Body schema: application/json

any (MeasureReport)

Responses

200

Success

post /MeasureReport

https://dev-pineapple-fhir.azurehealthcareapis.com/MeasureReport

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
identifier	string External identifier of the measure report to be returned
patient	string The identity of a patient to search for individual measure report results for
status	string The status of the measure report
_format	string

Responses

200

Success

get /MeasureReport

https://dev-pineapple-fhir.azurehealthcareapis.com/MeasureReport

<no summary>

path Parameters

required

string

Responses

200

Success

get /MeasureReport/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/MeasureReport/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

any (MeasureReport)

Responses

200

Success

put /MeasureReport/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/MeasureReport/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

path Parameters

required

string

Responses

200

Success

delete /MeasureReport/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/MeasureReport/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /MeasureReport/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/MeasureReport/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /MeasureReport/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/MeasureReport/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /MeasureReport/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/MeasureReport/{id}/_history/{vid}

Media

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
type required	string non-empty
subtype required	object
subject required	object
operator required	object
deviceName required	string non-empty
height required	number
width required	number
frames required	number
_frames required	object
content required	object

Responses

200

Success

post /Media

https://dev-pineapple-fhir.azurehealthcareapis.com/Media

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"type": "string",
"subtype":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string"
    }
  ]
},
"subject":
{
- "reference": "string"
},
"operator":
{
- "reference": "string"
},
"deviceName": "string",
"height": 0,
"width": 0,
"frames": 0,
"_frames":
{
- "fhir_comments":
  [
  - { }
  ]
},
"content":
{
- "id": "string",
- "contentType": "string",
- "data": "string",
- "creation": "string",
- "_creation":
  {
  - "fhir_comments":
    [
    { }
    ]
  }
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
based-on	string Procedure that caused this media to be created
context	string Encounter / Episode associated with media
created	string <date> Date attachment was first created
date	string <date> When Media was collected
device	string Observing Device
identifier	string Identifier(s) for the image
operator	string The person who generated the image
patient	string Who/What this Media is a record of
site	string Body part in media
subject	string Who/What this Media is a record of
subtype	string The type of acquisition equipment/process
type	string photo \| video \| audio
view	string Imaging view, e.g. Lateral or Antero-posterior
_format	string

Responses

200

Success

get /Media

https://dev-pineapple-fhir.azurehealthcareapis.com/Media

<no summary>

path Parameters

required

string

Responses

200

Success

get /Media/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Media/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
type required	string non-empty
subtype required	object
subject required	object
operator required	object
deviceName required	string non-empty
height required	number
width required	number
frames required	number
_frames required	object
content required	object

Responses

200

Success

put /Media/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Media/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"type": "string",
"subtype":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string"
    }
  ]
},
"subject":
{
- "reference": "string"
},
"operator":
{
- "reference": "string"
},
"deviceName": "string",
"height": 0,
"width": 0,
"frames": 0,
"_frames":
{
- "fhir_comments":
  [
  - { }
  ]
},
"content":
{
- "id": "string",
- "contentType": "string",
- "data": "string",
- "creation": "string",
- "_creation":
  {
  - "fhir_comments":
    [
    { }
    ]
  }
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Media/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Media/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Media/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Media/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Media/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Media/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Media/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Media/{id}/_history/{vid}

Medication

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
code required	object
isBrand required	boolean
package required	object

Responses

200

Success

post /Medication

https://dev-pineapple-fhir.azurehealthcareapis.com/Medication

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"code":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string",
    "_display":
    {
    "fhir_comments":
    [
    { }
    ]
    }
    }
  ]
},
"isBrand": true,
"package":
{
- "fhir_comments":
  [
  - { }
  ],
- "container":
  {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
  }
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
code	string Codes that identify this medication
container	string E.g. box, vial, blister-pack
form	string powder \| tablets \| capsule +
ingredient-code	string The product contained
ingredient	string The product contained
manufacturer	string Manufacturer of the item
over-the-counter	string True if medication does not require a prescription
package-item-code	string The item in the package
package-item	string The item in the package
status	string active \| inactive \| entered-in-error
_format	string

Responses

200

Success

get /Medication

https://dev-pineapple-fhir.azurehealthcareapis.com/Medication

<no summary>

path Parameters

required

string

Responses

200

Success

get /Medication/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Medication/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
code required	object
isBrand required	boolean
package required	object

Responses

200

Success

put /Medication/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Medication/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"code":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string",
    "_display":
    {
    "fhir_comments":
    [
    { }
    ]
    }
    }
  ]
},
"isBrand": true,
"package":
{
- "fhir_comments":
  [
  - { }
  ],
- "container":
  {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
  }
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Medication/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Medication/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Medication/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Medication/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Medication/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Medication/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Medication/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Medication/{id}/_history/{vid}

MedicationAdministration

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
status required	string non-empty
medicationReference required	object
patient required	object
effectiveTimePeriod required	object
practitioner required	object
prescription required	object
dosage required	object

Responses

200

Success

post /MedicationAdministration

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationAdministration

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"status": "string",
"medicationReference":
{
- "reference": "string"
},
"patient":
{
- "reference": "string"
},
"effectiveTimePeriod":
{
- "start": "string",
- "end": "string"
},
"practitioner":
{
- "reference": "string"
},
"prescription":
{
- "reference": "string"
},
"dosage":
{
- "route":
  {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
  },
- "quantity":
  {
  - "value": 0,
  - "system": "string",
  - "code": "string"
  }
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
code	string Return administrations of this medication code
context	string Return administrations that share this encounter or episode of care
device	string Return administrations with this administration device identity
effective-time	string <date> Date administration happened (or did not happen)
identifier	string Return administrations with this external identifier
medication	string Return administrations of this medication resource
not-given	string Administrations that were not made
patient	string The identity of a patient to list administrations for
performer	string The identify of the individual who administered the medication
prescription	string The identity of a prescription to list administrations from
reason-given	string Reasons for administering the medication
reason-not-given	string Reasons for not administering the medication
status	string MedicationAdministration event status (for example one of active/paused/completed/nullified)
subject	string The identify of the individual or group to list administrations for
_format	string

Responses

200

Success

get /MedicationAdministration

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationAdministration

<no summary>

path Parameters

required

string

Responses

200

Success

get /MedicationAdministration/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationAdministration/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
status required	string non-empty
medicationReference required	object
patient required	object
effectiveTimePeriod required	object
practitioner required	object
prescription required	object
dosage required	object

Responses

200

Success

put /MedicationAdministration/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationAdministration/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"status": "string",
"medicationReference":
{
- "reference": "string"
},
"patient":
{
- "reference": "string"
},
"effectiveTimePeriod":
{
- "start": "string",
- "end": "string"
},
"practitioner":
{
- "reference": "string"
},
"prescription":
{
- "reference": "string"
},
"dosage":
{
- "route":
  {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
  },
- "quantity":
  {
  - "value": 0,
  - "system": "string",
  - "code": "string"
  }
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /MedicationAdministration/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationAdministration/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /MedicationAdministration/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationAdministration/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /MedicationAdministration/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationAdministration/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /MedicationAdministration/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationAdministration/{id}/_history/{vid}

MedicationDispense

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
status required	string non-empty
medicationReference required	object
patient required	object
dispenser required	object
authorizingPrescription required	Array of objects non-empty
type required	object
quantity required	object
daysSupply required	object
whenPrepared required	string non-empty
whenHandedOver required	string non-empty
dosageInstruction required	Array of objects non-empty

Responses

200

Success

post /MedicationDispense

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationDispense

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"status": "string",
"medicationReference":
{
- "reference": "string",
- "_reference":
  {
  - "fhir_comments":
    [
    { }
    ]
  },
- "display": "string"
},
"patient":
{
- "reference": "string"
},
"dispenser":
{
- "reference": "string"
},
"authorizingPrescription":
[
- {
  - "reference": "string"
  }
],
"type":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"quantity":
{
- "value": 0,
- "unit": "string",
- "system": "string",
- "code": "string"
},
"daysSupply":
{
- "value": 0,
- "unit": "string",
- "system": "string",
- "code": "string"
},
"whenPrepared": "string",
"whenHandedOver": "string",
"dosageInstruction":
[
- {
  - "additionalInstructions":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    },
  - "timing":
    {
    "repeat":
    {
    "frequency": 0,
    "period": 0,
    "periodUnit": "string"
    }
    },
  - "siteCodeableConcept":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    },
  - "route":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    },
  - "doseQuantity":
    {
    "value": 0,
    "unit": "string",
    "system": "string",
    "code": "string"
    }
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
code	string Return dispenses of this medicine code
context	string Returns dispenses with a specific context (episode or episode of care)
destination	string Return dispenses that should be sent to a specific destination
identifier	string Return dispenses with this external identifier
medication	string Return dispenses of this medicine resource
patient	string The identity of a patient to list dispenses for
performer	string Return dispenses performed by a specific individual
prescription	string The identity of a prescription to list dispenses from
receiver	string The identity of a receiver to list dispenses for
responsibleparty	string Return dispenses with the specified responsible party
status	string Return dispenses with a specified dispense status
subject	string The identity of a patient to list dispenses for
type	string Return dispenses of a specific type
whenhandedover	string <date> Returns dispenses handed over on this date
whenprepared	string <date> Returns dispenses prepared on this date
_format	string

Responses

200

Success

get /MedicationDispense

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationDispense

<no summary>

path Parameters

required

string

Responses

200

Success

get /MedicationDispense/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationDispense/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
status required	string non-empty
medicationReference required	object
patient required	object
dispenser required	object
authorizingPrescription required	Array of objects non-empty
type required	object
quantity required	object
daysSupply required	object
whenPrepared required	string non-empty
whenHandedOver required	string non-empty
dosageInstruction required	Array of objects non-empty

Responses

200

Success

put /MedicationDispense/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationDispense/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"status": "string",
"medicationReference":
{
- "reference": "string",
- "_reference":
  {
  - "fhir_comments":
    [
    { }
    ]
  },
- "display": "string"
},
"patient":
{
- "reference": "string"
},
"dispenser":
{
- "reference": "string"
},
"authorizingPrescription":
[
- {
  - "reference": "string"
  }
],
"type":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"quantity":
{
- "value": 0,
- "unit": "string",
- "system": "string",
- "code": "string"
},
"daysSupply":
{
- "value": 0,
- "unit": "string",
- "system": "string",
- "code": "string"
},
"whenPrepared": "string",
"whenHandedOver": "string",
"dosageInstruction":
[
- {
  - "additionalInstructions":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    },
  - "timing":
    {
    "repeat":
    {
    "frequency": 0,
    "period": 0,
    "periodUnit": "string"
    }
    },
  - "siteCodeableConcept":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    },
  - "route":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    },
  - "doseQuantity":
    {
    "value": 0,
    "unit": "string",
    "system": "string",
    "code": "string"
    }
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /MedicationDispense/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationDispense/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /MedicationDispense/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationDispense/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /MedicationDispense/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationDispense/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /MedicationDispense/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationDispense/{id}/_history/{vid}

MedicationRequest

<no summary>

Request Body schema: application/json

any (MedicationRequest)

Responses

200

Success

post /MedicationRequest

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationRequest

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
authoredon	string <date> Return prescriptions written on this date
category	string Returns prescriptions with different categories
code	string Return prescriptions of this medication code
context	string Return prescriptions with this encounter or episode of care identifier
date	string <date> Returns medication request to be administered on a specific date
identifier	string Return prescriptions with this external identifier
intended-dispenser	string Returns prescriptions intended to be dispensed by this Organization
intent	string Returns prescriptions with different intents
medication	string Return prescriptions of this medication reference
patient	string Returns prescriptions for a specific patient
priority	string Returns prescriptions with different priorities
requester	string Returns prescriptions prescribed by this prescriber
status	string Status of the prescription
subject	string The identity of a patient to list orders for
_format	string

Responses

200

Success

get /MedicationRequest

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationRequest

<no summary>

path Parameters

required

string

Responses

200

Success

get /MedicationRequest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationRequest/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

any (MedicationRequest)

Responses

200

Success

put /MedicationRequest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationRequest/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

path Parameters

required

string

Responses

200

Success

delete /MedicationRequest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationRequest/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /MedicationRequest/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationRequest/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /MedicationRequest/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationRequest/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /MedicationRequest/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationRequest/{id}/_history/{vid}

MedicationStatement

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
status required	string non-empty
medicationReference required	object
patient required	object
effectiveDateTime required	string non-empty
informationSource required	object
dateAsserted required	string non-empty
wasNotTaken required	boolean
reasonForUseCodeableConcept required	object
note required	Array of objects non-empty
dosage required	Array of objects non-empty

Responses

200

Success

post /MedicationStatement

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationStatement

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"status": "string",
"medicationReference":
{
- "reference": "string",
- "_reference":
  {
  - "fhir_comments":
    [
    { }
    ]
  }
},
"patient":
{
- "reference": "string"
},
"effectiveDateTime": "string",
"informationSource":
{
- "reference": "string"
},
"dateAsserted": "string",
"wasNotTaken": true,
"reasonForUseCodeableConcept":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"note":
[
- {
  - "text": "string"
  }
],
"dosage":
[
- {
  - "text": "string",
  - "timing":
    {
    "repeat":
    {
    "frequency": 0,
    "period": 0,
    "periodUnit": "string"
    }
    },
  - "asNeededBoolean": true,
  - "route":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    },
  - "quantityQuantity":
    {
    "value": 0
    },
  - "maxDosePerPeriod":
    {
    "numerator":
    {
    "value": 0,
    "unit": "string",
    "system": "string",
    "code": "string"
    },
    "denominator":
    {
    "value": 0,
    "system": "string",
    "code": "string"
    }
    }
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
category	string Returns statements of this category of medicationstatement
code	string Return statements of this medication code
context	string Returns statements for a specific context (episode or episode of Care).
effective	string <date> Date when patient was taking (or not taking) the medication
identifier	string Return statements with this external identifier
medication	string Return statements of this medication reference
part-of	string Returns statements that are part of another event.
patient	string Returns statements for a specific patient.
source	string Who or where the information in the statement came from
status	string Return statements that match the given status
subject	string The identity of a patient, animal or group to list statements for
_format	string

Responses

200

Success

get /MedicationStatement

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationStatement

<no summary>

path Parameters

required

string

Responses

200

Success

get /MedicationStatement/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationStatement/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
status required	string non-empty
medicationReference required	object
patient required	object
effectiveDateTime required	string non-empty
informationSource required	object
dateAsserted required	string non-empty
wasNotTaken required	boolean
reasonForUseCodeableConcept required	object
note required	Array of objects non-empty
dosage required	Array of objects non-empty

Responses

200

Success

put /MedicationStatement/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationStatement/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"status": "string",
"medicationReference":
{
- "reference": "string",
- "_reference":
  {
  - "fhir_comments":
    [
    { }
    ]
  }
},
"patient":
{
- "reference": "string"
},
"effectiveDateTime": "string",
"informationSource":
{
- "reference": "string"
},
"dateAsserted": "string",
"wasNotTaken": true,
"reasonForUseCodeableConcept":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"note":
[
- {
  - "text": "string"
  }
],
"dosage":
[
- {
  - "text": "string",
  - "timing":
    {
    "repeat":
    {
    "frequency": 0,
    "period": 0,
    "periodUnit": "string"
    }
    },
  - "asNeededBoolean": true,
  - "route":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    },
  - "quantityQuantity":
    {
    "value": 0
    },
  - "maxDosePerPeriod":
    {
    "numerator":
    {
    "value": 0,
    "unit": "string",
    "system": "string",
    "code": "string"
    },
    "denominator":
    {
    "value": 0,
    "system": "string",
    "code": "string"
    }
    }
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /MedicationStatement/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationStatement/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /MedicationStatement/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationStatement/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /MedicationStatement/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationStatement/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /MedicationStatement/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/MedicationStatement/{id}/_history/{vid}

MessageDefinition

<no summary>

Request Body schema: application/json

any (MessageDefinition)

Responses

200

Success

post /MessageDefinition

https://dev-pineapple-fhir.azurehealthcareapis.com/MessageDefinition

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
category	string The behavior associated with the message
date	string <date> The message definition publication date
description	string The description of the message definition
event	string The event that triggers the message
focus	string A resource that is a permitted focus of the message
identifier	string External identifier for the message definition
jurisdiction	string Intended jurisdiction for the message definition
name	string Computationally friendly name of the message definition
publisher	string Name of the publisher of the message definition
status	string The current status of the message definition
title	string The human-friendly name of the message definition
url	string The uri that identifies the message definition
version	string The business version of the message definition
_format	string

Responses

200

Success

get /MessageDefinition

https://dev-pineapple-fhir.azurehealthcareapis.com/MessageDefinition

<no summary>

path Parameters

required

string

Responses

200

Success

get /MessageDefinition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/MessageDefinition/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

any (MessageDefinition)

Responses

200

Success

put /MessageDefinition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/MessageDefinition/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

path Parameters

required

string

Responses

200

Success

delete /MessageDefinition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/MessageDefinition/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /MessageDefinition/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/MessageDefinition/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /MessageDefinition/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/MessageDefinition/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /MessageDefinition/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/MessageDefinition/{id}/_history/{vid}

MessageHeader

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
timestamp required	string non-empty
event required	object
response required	object
source required	object
destination required	Array of objects non-empty
enterer required	object
author required	object
responsible required	object
reason required	object
data required	Array of objects non-empty

Responses

200

Success

post /MessageHeader

https://dev-pineapple-fhir.azurehealthcareapis.com/MessageHeader

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"timestamp": "string",
"event":
{
- "system": "string",
- "code": "string"
},
"response":
{
- "identifier": "string",
- "code": "string"
},
"source":
{
- "name": "string",
- "software": "string",
- "version": "string",
- "contact":
  {
  - "system": "string",
  - "value": "string"
  },
- "endpoint": "string"
},
"destination":
[
- {
  - "name": "string",
  - "target":
    {
    "fhir_comments":
    [
    { }
    ],
    "reference": "string"
    },
  - "endpoint": "string"
  }
],
"enterer":
{
- "reference": "string"
},
"author":
{
- "reference": "string"
},
"responsible":
{
- "reference": "string"
},
"reason":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string"
    }
  ]
},
"data":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "reference": "string"
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
author	string The source of the decision
code	string ok \| transient-error \| fatal-error
destination	string Name of system
destination-uri	string Actual destination address or id
enterer	string The source of the data entry
event	string Code for the event this message represents
focus	string The actual content of the message
receiver	string "Intended "real-world" recipient for the data"
response-id	string Id of original message
responsible	string Final responsibility for event
sender	string Real world sender of the message
source	string Name of system
source-uri	string Actual message source address or id
target	string Particular delivery destination within the destination
timestamp	string <date> Time that the message was sent
_format	string

Responses

200

Success

get /MessageHeader

https://dev-pineapple-fhir.azurehealthcareapis.com/MessageHeader

<no summary>

path Parameters

required

string

Responses

200

Success

get /MessageHeader/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/MessageHeader/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
timestamp required	string non-empty
event required	object
response required	object
source required	object
destination required	Array of objects non-empty
enterer required	object
author required	object
responsible required	object
reason required	object
data required	Array of objects non-empty

Responses

200

Success

put /MessageHeader/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/MessageHeader/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"timestamp": "string",
"event":
{
- "system": "string",
- "code": "string"
},
"response":
{
- "identifier": "string",
- "code": "string"
},
"source":
{
- "name": "string",
- "software": "string",
- "version": "string",
- "contact":
  {
  - "system": "string",
  - "value": "string"
  },
- "endpoint": "string"
},
"destination":
[
- {
  - "name": "string",
  - "target":
    {
    "fhir_comments":
    [
    { }
    ],
    "reference": "string"
    },
  - "endpoint": "string"
  }
],
"enterer":
{
- "reference": "string"
},
"author":
{
- "reference": "string"
},
"responsible":
{
- "reference": "string"
},
"reason":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string"
    }
  ]
},
"data":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "reference": "string"
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /MessageHeader/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/MessageHeader/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /MessageHeader/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/MessageHeader/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /MessageHeader/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/MessageHeader/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /MessageHeader/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/MessageHeader/{id}/_history/{vid}

NamingSystem

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
name required	string non-empty
status required	string non-empty
kind required	string non-empty
date required	string non-empty
publisher required	string non-empty
contact required	Array of objects non-empty
responsible required	string non-empty
description required	string non-empty
uniqueId required	Array of objects non-empty

Responses

200

Success

post /NamingSystem

https://dev-pineapple-fhir.azurehealthcareapis.com/NamingSystem

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"name": "string",
"status": "string",
"kind": "string",
"date": "string",
"publisher": "string",
"contact":
[
- {
  - "name": "string",
  - "telecom":
    [
    {
    "system": "string",
    "value": "string"
    }
    ]
  }
],
"responsible": "string",
"description": "string",
"uniqueId":
[
- {
  - "type": "string",
  - "value": "string",
  - "preferred": true
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
contact	string Name of an individual to contact
date	string <date> The naming system publication date
description	string The description of the naming system
id-type	string oid \| uuid \| uri \| other
jurisdiction	string Intended jurisdiction for the naming system
kind	string codesystem \| identifier \| root
name	string Computationally friendly name of the naming system
period	string <date> When is identifier valid?
publisher	string Name of the publisher of the naming system
replaced-by	string Use this instead
responsible	string Who maintains system namespace?
status	string The current status of the naming system
telecom	string Contact details for individual or organization
type	string e.g. driver, provider, patient, bank etc.
value	string The unique identifier
_format	string

Responses

200

Success

get /NamingSystem

https://dev-pineapple-fhir.azurehealthcareapis.com/NamingSystem

<no summary>

path Parameters

required

string

Responses

200

Success

get /NamingSystem/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/NamingSystem/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
name required	string non-empty
status required	string non-empty
kind required	string non-empty
date required	string non-empty
publisher required	string non-empty
contact required	Array of objects non-empty
responsible required	string non-empty
description required	string non-empty
uniqueId required	Array of objects non-empty

Responses

200

Success

put /NamingSystem/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/NamingSystem/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"name": "string",
"status": "string",
"kind": "string",
"date": "string",
"publisher": "string",
"contact":
[
- {
  - "name": "string",
  - "telecom":
    [
    {
    "system": "string",
    "value": "string"
    }
    ]
  }
],
"responsible": "string",
"description": "string",
"uniqueId":
[
- {
  - "type": "string",
  - "value": "string",
  - "preferred": true
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /NamingSystem/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/NamingSystem/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /NamingSystem/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/NamingSystem/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /NamingSystem/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/NamingSystem/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /NamingSystem/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/NamingSystem/{id}/_history/{vid}

NutritionOrder

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
_id required	object
text required	object
identifier required	Array of objects non-empty
status required	string non-empty
patient required	object
encounter required	object
dateTime required	string non-empty
orderer required	object
allergyIntolerance required	Array of objects non-empty
foodPreferenceModifier required	Array of objects non-empty
excludeFoodModifier required	Array of objects non-empty
oralDiet required	object

Responses

200

Success

post /NutritionOrder

https://dev-pineapple-fhir.azurehealthcareapis.com/NutritionOrder

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"_id":
{
- "fhir_comments":
  [
  - { }
  ]
},
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"status": "string",
"patient":
{
- "reference": "string",
- "display": "string"
},
"encounter":
{
- "reference": "string",
- "display": "string"
},
"dateTime": "string",
"orderer":
{
- "reference": "string",
- "display": "string"
},
"allergyIntolerance":
[
- {
  - "reference": "string",
  - "display": "string"
  }
],
"foodPreferenceModifier":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
  }
],
"excludeFoodModifier":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "version": "string",
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"oralDiet":
{
- "type":
  [
  - {
    "fhir_comments":
    [
    { }
    ],
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ],
    "text": "string"
    }
  ],
- "nutrient":
  [
  - {
    "fhir_comments":
    [
    { }
    ],
    "modifier":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    },
    "amount":
    {
    "value": 0,
    "unit": "string",
    "system": "string",
    "code": "string"
    }
    }
  ],
- "instruction": "string",
- "_instruction":
  {
  - "fhir_comments":
    [
    { }
    ]
  }
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
additive	string Type of module component to add to the feeding
datetime	string <date> Return nutrition orders requested on this date
encounter	string Return nutrition orders with this encounter identifier
formula	string Type of enteral or infant formula
identifier	string Return nutrition orders with this external identifier
oraldiet	string Type of diet that can be consumed orally (i.e., take via the mouth).
patient	string The identity of the person who requires the diet, formula or nutritional supplement
provider	string The identify of the provider who placed the nutrition order
status	string Status of the nutrition order.
supplement	string Type of supplement product requested
_format	string

Responses

200

Success

get /NutritionOrder

https://dev-pineapple-fhir.azurehealthcareapis.com/NutritionOrder

<no summary>

path Parameters

required

string

Responses

200

Success

get /NutritionOrder/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/NutritionOrder/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
_id required	object
text required	object
identifier required	Array of objects non-empty
status required	string non-empty
patient required	object
encounter required	object
dateTime required	string non-empty
orderer required	object
allergyIntolerance required	Array of objects non-empty
foodPreferenceModifier required	Array of objects non-empty
excludeFoodModifier required	Array of objects non-empty
oralDiet required	object

Responses

200

Success

put /NutritionOrder/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/NutritionOrder/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"_id":
{
- "fhir_comments":
  [
  - { }
  ]
},
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"status": "string",
"patient":
{
- "reference": "string",
- "display": "string"
},
"encounter":
{
- "reference": "string",
- "display": "string"
},
"dateTime": "string",
"orderer":
{
- "reference": "string",
- "display": "string"
},
"allergyIntolerance":
[
- {
  - "reference": "string",
  - "display": "string"
  }
],
"foodPreferenceModifier":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
  }
],
"excludeFoodModifier":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "version": "string",
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"oralDiet":
{
- "type":
  [
  - {
    "fhir_comments":
    [
    { }
    ],
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ],
    "text": "string"
    }
  ],
- "nutrient":
  [
  - {
    "fhir_comments":
    [
    { }
    ],
    "modifier":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    },
    "amount":
    {
    "value": 0,
    "unit": "string",
    "system": "string",
    "code": "string"
    }
    }
  ],
- "instruction": "string",
- "_instruction":
  {
  - "fhir_comments":
    [
    { }
    ]
  }
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /NutritionOrder/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/NutritionOrder/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /NutritionOrder/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/NutritionOrder/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /NutritionOrder/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/NutritionOrder/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /NutritionOrder/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/NutritionOrder/{id}/_history/{vid}

Observation

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
status required	string non-empty
category required	object
code required	object
subject required	object
encounter required	object
effectiveDateTime required	string non-empty
valueQuantity required	object

Responses

200

Success

post /Observation

https://dev-pineapple-fhir.azurehealthcareapis.com/Observation

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "fhir_comments":
  [
  - { }
  ],
- "status": "string",
- "div": "string"
},
"status": "string",
"category":
{
- "fhir_comments":
  [
  - { }
  ],
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"code":
{
- "fhir_comments":
  [
  - { }
  ],
- "coding":
  [
  - {
    "fhir_comments":
    [
    { }
    ],
    "system": "string",
    "code": "string",
    "display": "string",
    "_display":
    {
    "fhir_comments":
    [
    { }
    ]
    }
    }
  ]
},
"subject":
{
- "reference": "string"
},
"encounter":
{
- "reference": "string"
},
"effectiveDateTime": "string",
"valueQuantity":
{
- "fhir_comments":
  [
  - { }
  ],
- "value": 0,
- "unit": "string",
- "system": "string",
- "code": "string"
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
based-on	string Reference to the test or procedure request.
category	string The classification of the type of observation
code	string The code of the observation type
code-value-concept	string Code and coded value parameter pair
code-value-date	string Code and date/time value parameter pair
code-value-quantity	string Code and quantity value parameter pair
code-value-string	string Code and string value parameter pair
combo-code	string The code of the observation type or component type
combo-code-value-concept	string Code and coded value parameter pair, including in components
combo-code-value-quantity	string Code and quantity value parameter pair, including in components
combo-data-absent-reason	string The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing.
combo-value-concept	string The value or component value of the observation, if the value is a CodeableConcept
combo-value-quantity	integer The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)
component-code	string The component code of the observation type
component-code-value-concept	string Component code and component coded value parameter pair
component-code-value-quantity	string Component code and component quantity value parameter pair
component-data-absent-reason	string The reason why the expected value in the element Observation.component.value[x] is missing.
component-value-concept	string The value of the component observation, if the value is a CodeableConcept
component-value-quantity	integer The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)
context	string Healthcare event (Episode-of-care or Encounter) related to the observation
data-absent-reason	string The reason why the expected value in the element Observation.value[x] is missing.
date	string <date> Obtained date/time. If the obtained element is a period, a date that falls in the period
device	string The Device that generated the observation data.
encounter	string Encounter related to the observation
identifier	string The unique id for a particular observation
method	string The method used for the observation
patient	string The subject that the observation is about (if patient)
performer	string Who performed the observation
related	string Related Observations - search on related-type and related-target together
related-target	string Resource that is related to this one
related-type	string has-member \| derived-from \| sequel-to \| replaces \| qualified-by \| interfered-by
specimen	string Specimen used for this observation
status	string The status of the observation
subject	string The subject that the observation is about
value-concept	string The value of the observation, if the value is a CodeableConcept
value-date	string <date> The value of the observation, if the value is a date or period of time
value-quantity	integer The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)
value-string	string The value of the observation, if the value is a string, and also searches in CodeableConcept.text
_format	string

Responses

200

Success

get /Observation

https://dev-pineapple-fhir.azurehealthcareapis.com/Observation

<no summary>

path Parameters

required

string

Responses

200

Success

get /Observation/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Observation/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
status required	string non-empty
category required	object
code required	object
subject required	object
encounter required	object
effectiveDateTime required	string non-empty
valueQuantity required	object

Responses

200

Success

put /Observation/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Observation/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "fhir_comments":
  [
  - { }
  ],
- "status": "string",
- "div": "string"
},
"status": "string",
"category":
{
- "fhir_comments":
  [
  - { }
  ],
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"code":
{
- "fhir_comments":
  [
  - { }
  ],
- "coding":
  [
  - {
    "fhir_comments":
    [
    { }
    ],
    "system": "string",
    "code": "string",
    "display": "string",
    "_display":
    {
    "fhir_comments":
    [
    { }
    ]
    }
    }
  ]
},
"subject":
{
- "reference": "string"
},
"encounter":
{
- "reference": "string"
},
"effectiveDateTime": "string",
"valueQuantity":
{
- "fhir_comments":
  [
  - { }
  ],
- "value": 0,
- "unit": "string",
- "system": "string",
- "code": "string"
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Observation/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Observation/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Observation/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Observation/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Observation/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Observation/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Observation/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Observation/{id}/_history/{vid}

OperationDefinition

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
url required	string non-empty
version required	string non-empty
name required	string non-empty
status required	string non-empty
kind required	string non-empty
date required	string non-empty
publisher required	string non-empty
contact required	Array of objects non-empty
description required	string non-empty
code required	string non-empty
comment required	string non-empty
base required	object
system required	boolean
type required	Array of objects
instance required	boolean
parameter required	Array of objects non-empty

Responses

200

Success

post /OperationDefinition

https://dev-pineapple-fhir.azurehealthcareapis.com/OperationDefinition

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"url": "string",
"version": "string",
"name": "string",
"status": "string",
"kind": "string",
"date": "string",
"publisher": "string",
"contact":
[
- {
  - "name": "string",
  - "telecom":
    [
    {
    "system": "string",
    "value": "string"
    }
    ]
  }
],
"description": "string",
"code": "string",
"comment": "string",
"base":
{
- "reference": "string"
},
"system": true,
"type":
[
- { }
],
"instance": true,
"parameter":
[
- {
  - "name": "string",
  - "use": "string",
  - "min": 0,
  - "max": "string",
  - "documentation": "string",
  - "type": "string"
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
base	string Marks this as a profile of the base
code	string Name used to invoke the operation
date	string <date> The operation definition publication date
description	string The description of the operation definition
instance	string Invoke on an instance?
jurisdiction	string Intended jurisdiction for the operation definition
kind	string operation \| query
name	string Computationally friendly name of the operation definition
param-profile	string Profile on the type
publisher	string Name of the publisher of the operation definition
status	string The current status of the operation definition
system	string Invoke at the system level?
type	string Invole at the type level?
url	string The uri that identifies the operation definition
version	string The business version of the operation definition
_format	string

Responses

200

Success

get /OperationDefinition

https://dev-pineapple-fhir.azurehealthcareapis.com/OperationDefinition

<no summary>

path Parameters

required

string

Responses

200

Success

get /OperationDefinition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/OperationDefinition/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
url required	string non-empty
version required	string non-empty
name required	string non-empty
status required	string non-empty
kind required	string non-empty
date required	string non-empty
publisher required	string non-empty
contact required	Array of objects non-empty
description required	string non-empty
code required	string non-empty
comment required	string non-empty
base required	object
system required	boolean
type required	Array of objects
instance required	boolean
parameter required	Array of objects non-empty

Responses

200

Success

put /OperationDefinition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/OperationDefinition/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"url": "string",
"version": "string",
"name": "string",
"status": "string",
"kind": "string",
"date": "string",
"publisher": "string",
"contact":
[
- {
  - "name": "string",
  - "telecom":
    [
    {
    "system": "string",
    "value": "string"
    }
    ]
  }
],
"description": "string",
"code": "string",
"comment": "string",
"base":
{
- "reference": "string"
},
"system": true,
"type":
[
- { }
],
"instance": true,
"parameter":
[
- {
  - "name": "string",
  - "use": "string",
  - "min": 0,
  - "max": "string",
  - "documentation": "string",
  - "type": "string"
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /OperationDefinition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/OperationDefinition/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /OperationDefinition/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/OperationDefinition/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /OperationDefinition/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/OperationDefinition/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /OperationDefinition/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/OperationDefinition/{id}/_history/{vid}

OperationOutcome

Organization

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
extension required	Array of objects non-empty
name required	string non-empty
telecom required	Array of objects non-empty
address required	Array of objects non-empty

Responses

200

Success

post /Organization

https://dev-pineapple-fhir.azurehealthcareapis.com/Organization

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"extension":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "url": "string",
  - "valueString": "string"
  }
],
"name": "string",
"telecom":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"address":
[
- {
  - "line":
    [
    { }
    ],
  - "city": "string",
  - "state": "string",
  - "postalCode": "string",
  - "country": "string"
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
active	string A server defined search that may match any of the string fields in the Address, including line, city, state, country/region, postalCode, and/or text
address-city	string A city specified in an address
address-country	string A country/region specified in an address
address-postalcode	string A postal code specified in an address
address-state	string A state specified in an address
address	string A (part of the) address of the organization
address-use	string A use code specified in an address
endpoint	string Technical endpoints providing access to services operated for the organization
identifier	string Any identifier for the organization (not the accreditation issuer's identifier)
name	string A portion of the organization's name or alias
partof	string An organization of which this organization forms a part
phonetic	string A portion of the organization's name using some kind of phonetic matching algorithm
type	string A code for the type of organization
_format	string

Responses

200

Success

get /Organization

https://dev-pineapple-fhir.azurehealthcareapis.com/Organization

<no summary>

path Parameters

required

string

Responses

200

Success

get /Organization/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Organization/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
extension required	Array of objects non-empty
name required	string non-empty
telecom required	Array of objects non-empty
address required	Array of objects non-empty

Responses

200

Success

put /Organization/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Organization/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"extension":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "url": "string",
  - "valueString": "string"
  }
],
"name": "string",
"telecom":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"address":
[
- {
  - "line":
    [
    { }
    ],
  - "city": "string",
  - "state": "string",
  - "postalCode": "string",
  - "country": "string"
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Organization/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Organization/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Organization/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Organization/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Organization/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Organization/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Organization/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Organization/{id}/_history/{vid}

Patient

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
active required	boolean
name required	Array of objects non-empty
gender required	string non-empty
photo required	Array of objects non-empty
contact required	Array of objects non-empty
managingOrganization required	object
link required	Array of objects non-empty

Responses

200

Success

post /Patient

https://dev-pineapple-fhir.azurehealthcareapis.com/Patient

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "use": "string",
  - "type":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
    },
  - "system": "string",
  - "value": "string"
  }
],
"active": true,
"name":
[
- {
  - "use": "string",
  - "family":
    [
    { }
    ],
  - "given":
    [
    { }
    ]
  }
],
"gender": "string",
"photo":
[
- {
  - "contentType": "string",
  - "data": "string"
  }
],
"contact":
[
- {
  - "relationship":
    [
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
    }
    ],
  - "organization":
    {
    "reference": "string",
    "display": "string"
    }
  }
],
"managingOrganization":
{
- "reference": "string",
- "display": "string"
},
"link":
[
- {
  - "other":
    {
    "reference": "string"
    },
  - "type": "string"
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
active	string Whether the patient record is active
address-city	string A city specified in an address
address-country	string A country/region specified in an address
address-postalcode	string A postalCode specified in an address
address-state	string A state specified in an address
address	string A server defined search that may match any of the string fields in the Address, including line, city, state, country/region, postalCode, and/or text
address-use	string A use code specified in an address
animal-breed	string The breed for animal patients
animal-species	string The species for animal patients
birthdate	string <date> The patient's date of birth
death-date	string <date> The date of death has been provided and satisfies this search value
deceased	string This patient has been marked as deceased, or as a death date entered
email	string A value in an email contact
family	string A portion of the family name of the patient
gender	string Gender of the patient
general-practitioner	string Patient's nominated general practitioner, not the organization that manages the record
given	string A portion of the given name of the patient
identifier	string A patient identifier
language	string Language code (irrespective of use value)
link	string All patients linked to the given patient
name	string A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
organization	string The organization at which this person is a patient
phonetic	string A portion of either family or given name using some kind of phonetic matching algorithm
phone	string A value in a phone contact
telecom	string The value in any kind of telecom details of the patient
_format	string

Responses

200

Success

get /Patient

https://dev-pineapple-fhir.azurehealthcareapis.com/Patient

<no summary>

path Parameters

required

string

Responses

200

Success

get /Patient/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Patient/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
active required	boolean
name required	Array of objects non-empty
gender required	string non-empty
photo required	Array of objects non-empty
contact required	Array of objects non-empty
managingOrganization required	object
link required	Array of objects non-empty

Responses

200

Success

put /Patient/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Patient/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "use": "string",
  - "type":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
    },
  - "system": "string",
  - "value": "string"
  }
],
"active": true,
"name":
[
- {
  - "use": "string",
  - "family":
    [
    { }
    ],
  - "given":
    [
    { }
    ]
  }
],
"gender": "string",
"photo":
[
- {
  - "contentType": "string",
  - "data": "string"
  }
],
"contact":
[
- {
  - "relationship":
    [
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
    }
    ],
  - "organization":
    {
    "reference": "string",
    "display": "string"
    }
  }
],
"managingOrganization":
{
- "reference": "string",
- "display": "string"
},
"link":
[
- {
  - "other":
    {
    "reference": "string"
    },
  - "type": "string"
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Patient/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Patient/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Patient/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Patient/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Patient/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Patient/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Patient/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Patient/{id}/_history/{vid}

PaymentNotice

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
created required	string non-empty
organizationReference required	object
requestReference required	object
paymentStatus required	object

Responses

200

Success

post /PaymentNotice

https://dev-pineapple-fhir.azurehealthcareapis.com/PaymentNotice

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"created": "string",
"organizationReference":
{
- "reference": "string"
},
"requestReference":
{
- "reference": "string"
},
"paymentStatus":
{
- "system": "string",
- "code": "string"
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
created	string <date> Creation date fro the notice
identifier	string The business identifier of the notice
organization	string The organization who generated this resource
payment-status	string The type of payment notice
provider	string The reference to the provider
request	string The Claim
response	string The ClaimResponse
statusdate	string <date> The date of the payment action
_format	string

Responses

200

Success

get /PaymentNotice

https://dev-pineapple-fhir.azurehealthcareapis.com/PaymentNotice

<no summary>

path Parameters

required

string

Responses

200

Success

get /PaymentNotice/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/PaymentNotice/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
created required	string non-empty
organizationReference required	object
requestReference required	object
paymentStatus required	object

Responses

200

Success

put /PaymentNotice/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/PaymentNotice/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"created": "string",
"organizationReference":
{
- "reference": "string"
},
"requestReference":
{
- "reference": "string"
},
"paymentStatus":
{
- "system": "string",
- "code": "string"
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /PaymentNotice/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/PaymentNotice/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /PaymentNotice/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/PaymentNotice/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /PaymentNotice/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/PaymentNotice/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /PaymentNotice/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/PaymentNotice/{id}/_history/{vid}

PaymentReconciliation

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
requestReference required	object
outcome required	string non-empty
disposition required	string non-empty
created required	string non-empty
organizationReference required	object
detail required	Array of objects non-empty
total required	object

Responses

200

Success

post /PaymentReconciliation

https://dev-pineapple-fhir.azurehealthcareapis.com/PaymentReconciliation

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"requestReference":
{
- "reference": "string"
},
"outcome": "string",
"disposition": "string",
"created": "string",
"organizationReference":
{
- "reference": "string"
},
"detail":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "type":
    {
    "system": "string",
    "code": "string"
    },
  - "requestReference":
    {
    "reference": "string"
    },
  - "date": "string",
  - "amount":
    {
    "value": 0,
    "system": "string",
    "code": "string"
    }
  }
],
"total":
{
- "value": 0,
- "system": "string",
- "code": "string"
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
created	string <date> The creation date
disposition	string The contents of the disposition message
identifier	string The business identifier of the Explanation of Benefit
organization	string The organization who generated this resource
outcome	string The processing outcome
request-organization	string The organization who generated this resource
request-provider	string The reference to the provider who sumbitted the claim
request	string The reference to the claim
_format	string

Responses

200

Success

get /PaymentReconciliation

https://dev-pineapple-fhir.azurehealthcareapis.com/PaymentReconciliation

<no summary>

path Parameters

required

string

Responses

200

Success

get /PaymentReconciliation/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/PaymentReconciliation/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
requestReference required	object
outcome required	string non-empty
disposition required	string non-empty
created required	string non-empty
organizationReference required	object
detail required	Array of objects non-empty
total required	object

Responses

200

Success

put /PaymentReconciliation/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/PaymentReconciliation/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"requestReference":
{
- "reference": "string"
},
"outcome": "string",
"disposition": "string",
"created": "string",
"organizationReference":
{
- "reference": "string"
},
"detail":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "type":
    {
    "system": "string",
    "code": "string"
    },
  - "requestReference":
    {
    "reference": "string"
    },
  - "date": "string",
  - "amount":
    {
    "value": 0,
    "system": "string",
    "code": "string"
    }
  }
],
"total":
{
- "value": 0,
- "system": "string",
- "code": "string"
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /PaymentReconciliation/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/PaymentReconciliation/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /PaymentReconciliation/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/PaymentReconciliation/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /PaymentReconciliation/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/PaymentReconciliation/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /PaymentReconciliation/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/PaymentReconciliation/{id}/_history/{vid}

Person

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
name required	Array of objects non-empty
telecom required	Array of objects non-empty
gender required	string non-empty
_gender required	object
birthDate required	string non-empty
address required	Array of objects non-empty
active required	boolean
link required	Array of objects non-empty

Responses

200

Success

post /Person

https://dev-pineapple-fhir.azurehealthcareapis.com/Person

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "use": "string",
  - "type":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
    },
  - "system": "string",
  - "value": "string",
  - "period":
    {
    "start": "string"
    },
  - "assigner":
    {
    "display": "string"
    }
  }
],
"name":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "use": "string",
  - "family":
    [
    { }
    ],
  - "given":
    [
    { }
    ]
  }
],
"telecom":
[
- {
  - "system": "string",
  - "value": "string",
  - "use": "string"
  }
],
"gender": "string",
"_gender":
{
- "fhir_comments":
  [
  - { }
  ]
},
"birthDate": "string",
"address":
[
- {
  - "use": "string",
  - "line":
    [
    { }
    ],
  - "city": "string",
  - "state": "string",
  - "postalCode": "string"
  }
],
"active": true,
"link":
[
- {
  - "target":
    {
    "reference": "string",
    "display": "string"
    }
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
address-city	string A city specified in an address
address-country	string A country/region specified in an address
address-postalcode	string A postal code specified in an address
address-state	string A state specified in an address
address	string A server defined search that may match any of the string fields in the Address, including line, city, state, country/region, postalCode, and/or text
address-use	string A use code specified in an address
birthdate	string <date> The person's date of birth
email	string A value in an email contact
gender	string The gender of the person
identifier	string A person Identifier
link	string Any link has this Patient, Person, RelatedPerson or Practitioner reference
name	string A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
organization	string The organization at which this person record is being managed
patient	string The Person links to this Patient
phonetic	string A portion of name using some kind of phonetic matching algorithm
phone	string A value in a phone contact
practitioner	string The Person links to this Practitioner
relatedperson	string The Person links to this RelatedPerson
telecom	string The value in any kind of contact
_format	string

Responses

200

Success

get /Person

https://dev-pineapple-fhir.azurehealthcareapis.com/Person

<no summary>

path Parameters

required

string

Responses

200

Success

get /Person/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Person/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
name required	Array of objects non-empty
telecom required	Array of objects non-empty
gender required	string non-empty
_gender required	object
birthDate required	string non-empty
address required	Array of objects non-empty
active required	boolean
link required	Array of objects non-empty

Responses

200

Success

put /Person/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Person/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "use": "string",
  - "type":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
    },
  - "system": "string",
  - "value": "string",
  - "period":
    {
    "start": "string"
    },
  - "assigner":
    {
    "display": "string"
    }
  }
],
"name":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "use": "string",
  - "family":
    [
    { }
    ],
  - "given":
    [
    { }
    ]
  }
],
"telecom":
[
- {
  - "system": "string",
  - "value": "string",
  - "use": "string"
  }
],
"gender": "string",
"_gender":
{
- "fhir_comments":
  [
  - { }
  ]
},
"birthDate": "string",
"address":
[
- {
  - "use": "string",
  - "line":
    [
    { }
    ],
  - "city": "string",
  - "state": "string",
  - "postalCode": "string"
  }
],
"active": true,
"link":
[
- {
  - "target":
    {
    "reference": "string",
    "display": "string"
    }
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Person/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Person/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Person/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Person/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Person/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Person/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Person/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Person/{id}/_history/{vid}

PlanDefinition

<no summary>

Request Body schema: application/json

any (PlanDefinition)

Responses

200

Success

post /PlanDefinition

https://dev-pineapple-fhir.azurehealthcareapis.com/PlanDefinition

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
composed-of	string What resource is being referenced
date	string <date> The plan definition publication date
depends-on	string What resource is being referenced
derived-from	string What resource is being referenced
description	string The description of the plan definition
effective	string <date> The time during which the plan definition is intended to be in use
identifier	string External identifier for the plan definition
jurisdiction	string Intended jurisdiction for the plan definition
name	string Computationally friendly name of the plan definition
predecessor	string What resource is being referenced
publisher	string Name of the publisher of the plan definition
status	string The current status of the plan definition
successor	string What resource is being referenced
title	string The human-friendly name of the plan definition
topic	string Topics associated with the module
url	string The uri that identifies the plan definition
version	string The business version of the plan definition
_format	string

Responses

200

Success

get /PlanDefinition

https://dev-pineapple-fhir.azurehealthcareapis.com/PlanDefinition

<no summary>

path Parameters

required

string

Responses

200

Success

get /PlanDefinition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/PlanDefinition/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

any (PlanDefinition)

Responses

200

Success

put /PlanDefinition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/PlanDefinition/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

path Parameters

required

string

Responses

200

Success

delete /PlanDefinition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/PlanDefinition/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /PlanDefinition/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/PlanDefinition/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /PlanDefinition/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/PlanDefinition/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /PlanDefinition/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/PlanDefinition/{id}/_history/{vid}

Practitioner

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
active required	boolean
name required	Array of objects non-empty
practitionerRole required	Array of objects non-empty
qualification required	Array of objects non-empty

Responses

200

Success

post /Practitioner

https://dev-pineapple-fhir.azurehealthcareapis.com/Practitioner

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"active": true,
"name":
[
- {
  - "family":
    [
    { }
    ],
  - "given":
    [
    { }
    ],
  - "prefix":
    [
    { }
    ]
  }
],
"practitionerRole":
[
- {
  - "organization":
    {
    "reference": "string"
    },
  - "role":
    {
    "fhir_comments":
    [
    { }
    ],
    "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
    },
  - "period":
    {
    "start": "string",
    "end": "string"
    },
  - "location":
    [
    {
    "reference": "string",
    "display": "string"
    }
    ],
  - "healthcareService":
    [
    {
    "reference": "string"
    }
    ]
  }
],
"qualification":
[
- {
  - "identifier":
    [
    {
    "system": "string",
    "value": "string"
    }
    ],
  - "code":
    {
    "text": "string"
    },
  - "period":
    {
    "start": "string"
    },
  - "issuer":
    {
    "display": "string"
    }
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
active	string Whether the practitioner record is active
address-city	string A city specified in an address
address-country	string A country/region specified in an address
address-postalcode	string A postalCode specified in an address
address-state	string A state specified in an address
address	string A server defined search that may match any of the string fields in the Address, including line, city, state, country/region, postalCode, and/or text
address-use	string A use code specified in an address
communication	string One of the languages that the practitioner can communicate with
email	string A value in an email contact
family	string A portion of the family name
gender	string Gender of the practitioner
given	string A portion of the given name
identifier	string A practitioner's Identifier
name	string A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
phonetic	string A portion of either family or given name using some kind of phonetic matching algorithm
phone	string A value in a phone contact
telecom	string The value in any kind of contact
_format	string

Responses

200

Success

get /Practitioner

https://dev-pineapple-fhir.azurehealthcareapis.com/Practitioner

<no summary>

path Parameters

required

string

Responses

200

Success

get /Practitioner/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Practitioner/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
active required	boolean
name required	Array of objects non-empty
practitionerRole required	Array of objects non-empty
qualification required	Array of objects non-empty

Responses

200

Success

put /Practitioner/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Practitioner/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"active": true,
"name":
[
- {
  - "family":
    [
    { }
    ],
  - "given":
    [
    { }
    ],
  - "prefix":
    [
    { }
    ]
  }
],
"practitionerRole":
[
- {
  - "organization":
    {
    "reference": "string"
    },
  - "role":
    {
    "fhir_comments":
    [
    { }
    ],
    "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
    },
  - "period":
    {
    "start": "string",
    "end": "string"
    },
  - "location":
    [
    {
    "reference": "string",
    "display": "string"
    }
    ],
  - "healthcareService":
    [
    {
    "reference": "string"
    }
    ]
  }
],
"qualification":
[
- {
  - "identifier":
    [
    {
    "system": "string",
    "value": "string"
    }
    ],
  - "code":
    {
    "text": "string"
    },
  - "period":
    {
    "start": "string"
    },
  - "issuer":
    {
    "display": "string"
    }
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Practitioner/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Practitioner/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Practitioner/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Practitioner/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Practitioner/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Practitioner/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Practitioner/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Practitioner/{id}/_history/{vid}

PractitionerRole

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
active required	boolean
organization required	object
role required	Array of objects non-empty
location required	Array of objects non-empty
healthcareService required	Array of objects non-empty
telecom required	Array of objects non-empty
period required	object

Responses

200

Success

post /PractitionerRole

https://dev-pineapple-fhir.azurehealthcareapis.com/PractitionerRole

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"active": true,
"organization":
{
- "reference": "string"
},
"role":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
  }
],
"location":
[
- {
  - "reference": "string",
  - "display": "string"
  }
],
"healthcareService":
[
- {
  - "reference": "string"
  }
],
"telecom":
[
- {
  - "system": "string",
  - "value": "string",
  - "use": "string"
  }
],
"period":
{
- "start": "string",
- "end": "string"
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
active	string Whether this practitioner's record is in active use
date	string <date> The period during which the practitioner is authorized to perform in these role(s)
email	string A value in an email contact
endpoint	string Technical endpoints providing access to services operated for the practitioner with this role
identifier	string A practitioner's Identifier
location	string One of the locations at which this practitioner provides care
organization	string The identity of the organization the practitioner represents / acts on behalf of
phone	string A value in a phone contact
practitioner	string Practitioner that is able to provide the defined services for the organation
role	string The practitioner can perform this role at for the organization
service	string The list of healthcare services that this worker provides for this role's Organization/Location(s)
specialty	string The practitioner has this specialty at an organization
telecom	string The value in any kind of contact
_format	string

Responses

200

Success

get /PractitionerRole

https://dev-pineapple-fhir.azurehealthcareapis.com/PractitionerRole

<no summary>

path Parameters

required

string

Responses

200

Success

get /PractitionerRole/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/PractitionerRole/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
active required	boolean
organization required	object
role required	Array of objects non-empty
location required	Array of objects non-empty
healthcareService required	Array of objects non-empty
telecom required	Array of objects non-empty
period required	object

Responses

200

Success

put /PractitionerRole/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/PractitionerRole/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"active": true,
"organization":
{
- "reference": "string"
},
"role":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
  }
],
"location":
[
- {
  - "reference": "string",
  - "display": "string"
  }
],
"healthcareService":
[
- {
  - "reference": "string"
  }
],
"telecom":
[
- {
  - "system": "string",
  - "value": "string",
  - "use": "string"
  }
],
"period":
{
- "start": "string",
- "end": "string"
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /PractitionerRole/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/PractitionerRole/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /PractitionerRole/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/PractitionerRole/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /PractitionerRole/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/PractitionerRole/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /PractitionerRole/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/PractitionerRole/{id}/_history/{vid}

Procedure

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
subject required	object
status required	string non-empty
code required	object
reasonCodeableConcept required	object
performer required	Array of objects non-empty
performedDateTime required	string non-empty
followUp required	Array of objects non-empty
notes required	Array of objects non-empty

Responses

200

Success

post /Procedure

https://dev-pineapple-fhir.azurehealthcareapis.com/Procedure

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"subject":
{
- "reference": "string"
},
"status": "string",
"code":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ],
- "text": "string"
},
"reasonCodeableConcept":
{
- "text": "string"
},
"performer":
[
- {
  - "actor":
    {
    "reference": "string",
    "display": "string"
    }
  }
],
"performedDateTime": "string",
"followUp":
[
- {
  - "text": "string"
  }
],
"notes":
[
- {
  - "text": "string"
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
based-on	string A request for this procedure
category	string Classification of the procedure
code	string A code to identify a procedure
context	string Encounter or episode associated with the procedure
date	string <date> Date/Period the procedure was performed
definition	string Instantiates protocol or definition
encounter	string Search by encounter
identifier	string A unique identifier for a procedure
location	string Where the procedure happened
part-of	string Part of referenced event
patient	string Search by subject - a patient
performer	string The reference to the practitioner
status	string preparation \| in-progress \| suspended \| aborted \| completed \| entered-in-error \| unknown
subject	string Search by subject
_format	string

Responses

200

Success

get /Procedure

https://dev-pineapple-fhir.azurehealthcareapis.com/Procedure

<no summary>

path Parameters

required

string

Responses

200

Success

get /Procedure/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Procedure/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
subject required	object
status required	string non-empty
code required	object
reasonCodeableConcept required	object
performer required	Array of objects non-empty
performedDateTime required	string non-empty
followUp required	Array of objects non-empty
notes required	Array of objects non-empty

Responses

200

Success

put /Procedure/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Procedure/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"subject":
{
- "reference": "string"
},
"status": "string",
"code":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ],
- "text": "string"
},
"reasonCodeableConcept":
{
- "text": "string"
},
"performer":
[
- {
  - "actor":
    {
    "reference": "string",
    "display": "string"
    }
  }
],
"performedDateTime": "string",
"followUp":
[
- {
  - "text": "string"
  }
],
"notes":
[
- {
  - "text": "string"
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Procedure/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Procedure/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Procedure/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Procedure/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Procedure/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Procedure/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Procedure/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Procedure/{id}/_history/{vid}

ProcedureRequest

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
subject required	object
code required	object

Responses

200

Success

post /ProcedureRequest

https://dev-pineapple-fhir.azurehealthcareapis.com/ProcedureRequest

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"subject":
{
- "fhir_comments":
  [
  - { }
  ],
- "reference": "string"
},
"code":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
authored	string <date> Date request signed
based-on	string What request fulfills
body-site	string Where procedure is going to be done
code	string What is being requested/ordered
context	string Encounter or Episode during which request was created
definition	string Protocol or definition
encounter	string An encounter in which this request is made
identifier	string Identifiers assigned to this order
intent	string proposal \| plan \| order +
occurrence	string <date> When procedure should occur
patient	string Search by subject - a patient
performer	string Requested perfomer
performer-type	string Performer role
priority	string routine \| urgent \| asap \| stat
replaces	string What request replaces
requester	string Individual making the request
requisition	string Composite Request ID
specimen	string Specimen to be tested
status	string draft \| active \| suspended \| completed \| entered-in-error \| cancelled
subject	string Search by subject
_format	string

Responses

200

Success

get /ProcedureRequest

https://dev-pineapple-fhir.azurehealthcareapis.com/ProcedureRequest

<no summary>

path Parameters

required

string

Responses

200

Success

get /ProcedureRequest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ProcedureRequest/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
subject required	object
code required	object

Responses

200

Success

put /ProcedureRequest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ProcedureRequest/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"subject":
{
- "fhir_comments":
  [
  - { }
  ],
- "reference": "string"
},
"code":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /ProcedureRequest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ProcedureRequest/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /ProcedureRequest/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ProcedureRequest/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /ProcedureRequest/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ProcedureRequest/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /ProcedureRequest/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/ProcedureRequest/{id}/_history/{vid}

ProcessRequest

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
action required	string non-empty
identifier required	Array of objects non-empty
created required	string non-empty
organizationReference required	object

Responses

200

Success

post /ProcessRequest

https://dev-pineapple-fhir.azurehealthcareapis.com/ProcessRequest

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"action": "string",
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"created": "string",
"organizationReference":
{
- "reference": "string"
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
action	string The action requested by this resource
identifier	string The business identifier of the ProcessRequest
organization	string The organization who generated this request
provider	string The provider who regenerated this request
_format	string

Responses

200

Success

get /ProcessRequest

https://dev-pineapple-fhir.azurehealthcareapis.com/ProcessRequest

<no summary>

path Parameters

required

string

Responses

200

Success

get /ProcessRequest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ProcessRequest/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
action required	string non-empty
identifier required	Array of objects non-empty
created required	string non-empty
organizationReference required	object

Responses

200

Success

put /ProcessRequest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ProcessRequest/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"action": "string",
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"created": "string",
"organizationReference":
{
- "reference": "string"
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /ProcessRequest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ProcessRequest/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /ProcessRequest/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ProcessRequest/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /ProcessRequest/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ProcessRequest/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /ProcessRequest/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/ProcessRequest/{id}/_history/{vid}

ProcessResponse

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
fhir_comments required	Array of objects
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
requestReference required	object
outcome required	object
disposition required	string non-empty
created required	string non-empty
organizationReference required	object

Responses

200

Success

post /ProcessResponse

https://dev-pineapple-fhir.azurehealthcareapis.com/ProcessResponse

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"fhir_comments":
[
- { }
],
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"requestReference":
{
- "reference": "string"
},
"outcome":
{
- "system": "string",
- "code": "string"
},
"disposition": "string",
"created": "string",
"organizationReference":
{
- "reference": "string"
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
identifier	string The business identifier of the Explanation of Benefit
organization	string The organization who generated this resource
request-organization	string The Organization who is responsible the request transaction
request-provider	string The Provider who is responsible the request transaction
request	string The reference to the claim
_format	string

Responses

200

Success

get /ProcessResponse

https://dev-pineapple-fhir.azurehealthcareapis.com/ProcessResponse

<no summary>

path Parameters

required

string

Responses

200

Success

get /ProcessResponse/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ProcessResponse/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
fhir_comments required	Array of objects
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
requestReference required	object
outcome required	object
disposition required	string non-empty
created required	string non-empty
organizationReference required	object

Responses

200

Success

put /ProcessResponse/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ProcessResponse/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"fhir_comments":
[
- { }
],
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"requestReference":
{
- "reference": "string"
},
"outcome":
{
- "system": "string",
- "code": "string"
},
"disposition": "string",
"created": "string",
"organizationReference":
{
- "reference": "string"
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /ProcessResponse/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ProcessResponse/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /ProcessResponse/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ProcessResponse/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /ProcessResponse/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ProcessResponse/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /ProcessResponse/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/ProcessResponse/{id}/_history/{vid}

Provenance

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
target required	Array of objects non-empty
period required	object
recorded required	string non-empty
reason required	Array of objects non-empty
location required	object
policy required	Array of objects
_policy required	Array of objects non-empty
agent required	Array of objects non-empty
entity required	Array of objects non-empty

Responses

200

Success

post /Provenance

https://dev-pineapple-fhir.azurehealthcareapis.com/Provenance

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"target":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "reference": "string"
  }
],
"period":
{
- "start": "string"
},
"recorded": "string",
"reason":
[
- {
  - "system": "string",
  - "code": "string",
  - "display": "string"
  }
],
"location":
{
- "reference": "string"
},
"policy":
[
- { }
],
"_policy":
[
- {
  - "fhir_comments":
    [
    { }
    ]
  }
],
"agent":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "role":
    {
    "system": "string",
    "code": "string"
    },
  - "actor":
    {
    "reference": "string"
    },
  - "userId":
    {
    "fhir_comments":
    [
    { }
    ],
    "system": "string",
    "value": "string"
    },
  - "relatedAgent":
    [
    {
    "type":
    {
    "text": "string"
    },
    "target": "string"
    }
    ]
  }
],
"entity":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "role": "string",
  - "type":
    {
    "fhir_comments":
    [
    { }
    ],
    "system": "string",
    "code": "string",
    "display": "string"
    },
  - "reference": "string",
  - "_reference":
    {
    "fhir_comments":
    [
    { }
    ]
    },
  - "display": "string"
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
agent	string Who participated
agent-role	string What the agents role was
end	string <date> End time with inclusive boundary, if not ongoing
entity-id	string Identity of entity
entity-ref	string Identity of entity
location	string Where the activity occurred, if relevant
patient	string Target Reference(s) (usually version specific)
recorded	string <date> When the activity was recorded / updated
signature-type	string Indication of the reason the entity signed the object(s)
start	string <date> Starting time with inclusive boundary
target	string Target Reference(s) (usually version specific)
_format	string

Responses

200

Success

get /Provenance

https://dev-pineapple-fhir.azurehealthcareapis.com/Provenance

<no summary>

path Parameters

required

string

Responses

200

Success

get /Provenance/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Provenance/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
target required	Array of objects non-empty
period required	object
recorded required	string non-empty
reason required	Array of objects non-empty
location required	object
policy required	Array of objects
_policy required	Array of objects non-empty
agent required	Array of objects non-empty
entity required	Array of objects non-empty

Responses

200

Success

put /Provenance/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Provenance/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"target":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "reference": "string"
  }
],
"period":
{
- "start": "string"
},
"recorded": "string",
"reason":
[
- {
  - "system": "string",
  - "code": "string",
  - "display": "string"
  }
],
"location":
{
- "reference": "string"
},
"policy":
[
- { }
],
"_policy":
[
- {
  - "fhir_comments":
    [
    { }
    ]
  }
],
"agent":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "role":
    {
    "system": "string",
    "code": "string"
    },
  - "actor":
    {
    "reference": "string"
    },
  - "userId":
    {
    "fhir_comments":
    [
    { }
    ],
    "system": "string",
    "value": "string"
    },
  - "relatedAgent":
    [
    {
    "type":
    {
    "text": "string"
    },
    "target": "string"
    }
    ]
  }
],
"entity":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "role": "string",
  - "type":
    {
    "fhir_comments":
    [
    { }
    ],
    "system": "string",
    "code": "string",
    "display": "string"
    },
  - "reference": "string",
  - "_reference":
    {
    "fhir_comments":
    [
    { }
    ]
    },
  - "display": "string"
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Provenance/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Provenance/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Provenance/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Provenance/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Provenance/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Provenance/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Provenance/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Provenance/{id}/_history/{vid}

Questionnaire

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
status required	string non-empty
date required	string non-empty
title required	string non-empty
subjectType required	Array of objects
item required	Array of objects non-empty

Responses

200

Success

post /Questionnaire

https://dev-pineapple-fhir.azurehealthcareapis.com/Questionnaire

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"status": "string",
"date": "string",
"title": "string",
"subjectType":
[
- { }
],
"item":
[
- {
  - "linkId": "string",
  - "concept":
    [
    {
    "system": "string",
    "code": "string"
    }
    ],
  - "type": "string",
  - "item":
    [
    {
    "linkId": "string",
    "concept":
    [
    {
    "system": "string",
    "code": "string"
    }
    ],
    "type": "string",
    "options":
    {
    "reference": "string"
    },
    "item":
    [
    {
    "linkId": "string",
    "concept":
    [
    {
    "system": "string",
    "code": "string"
    }
    ],
    "type": "string",
    "item":
    [
    {
    "linkId": "string",
    "concept":
    [
    {
    "system": "string",
    "code": "string"
    }
    ],
    "type": "string",
    "options":
    {
    "reference": "string"
    }
    }
    ]
    }
    ]
    }
    ]
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
code	string A code that corresponds to one of its items in the questionnaire
date	string <date> The questionnaire publication date
description	string The description of the questionnaire
effective	string <date> The time during which the questionnaire is intended to be in use
identifier	string External identifier for the questionnaire
jurisdiction	string Intended jurisdiction for the questionnaire
name	string Computationally friendly name of the questionnaire
publisher	string Name of the publisher of the questionnaire
status	string The current status of the questionnaire
title	string The human-friendly name of the questionnaire
url	string The uri that identifies the questionnaire
version	string The business version of the questionnaire
_format	string

Responses

200

Success

get /Questionnaire

https://dev-pineapple-fhir.azurehealthcareapis.com/Questionnaire

<no summary>

path Parameters

required

string

Responses

200

Success

get /Questionnaire/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Questionnaire/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
status required	string non-empty
date required	string non-empty
title required	string non-empty
subjectType required	Array of objects
item required	Array of objects non-empty

Responses

200

Success

put /Questionnaire/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Questionnaire/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"status": "string",
"date": "string",
"title": "string",
"subjectType":
[
- { }
],
"item":
[
- {
  - "linkId": "string",
  - "concept":
    [
    {
    "system": "string",
    "code": "string"
    }
    ],
  - "type": "string",
  - "item":
    [
    {
    "linkId": "string",
    "concept":
    [
    {
    "system": "string",
    "code": "string"
    }
    ],
    "type": "string",
    "options":
    {
    "reference": "string"
    },
    "item":
    [
    {
    "linkId": "string",
    "concept":
    [
    {
    "system": "string",
    "code": "string"
    }
    ],
    "type": "string",
    "item":
    [
    {
    "linkId": "string",
    "concept":
    [
    {
    "system": "string",
    "code": "string"
    }
    ],
    "type": "string",
    "options":
    {
    "reference": "string"
    }
    }
    ]
    }
    ]
    }
    ]
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Questionnaire/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Questionnaire/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Questionnaire/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Questionnaire/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Questionnaire/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Questionnaire/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Questionnaire/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Questionnaire/{id}/_history/{vid}

QuestionnaireResponse

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
fhir_comments required	Array of objects
id required	string non-empty
text required	object
contained required	Array of objects non-empty
status required	string non-empty
subject required	object
author required	object
authored required	string non-empty
item required	Array of objects non-empty

Responses

200

Success

post /QuestionnaireResponse

https://dev-pineapple-fhir.azurehealthcareapis.com/QuestionnaireResponse

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"fhir_comments":
[
- { }
],
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"contained":
[
- {
  - "resourceType": "string",
  - "id": "string",
  - "status": "string",
  - "code":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    },
  - "subject":
    {
    "reference": "string"
    },
  - "performer":
    [
    {
    "reference": "string"
    }
    ],
  - "valueCodeableConcept":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    }
  }
],
"status": "string",
"subject":
{
- "reference": "string"
},
"author":
{
- "reference": "string"
},
"authored": "string",
"item":
[
- {
  - "item":
    [
    {
    "fhir_comments":
    [
    { }
    ],
    "answer":
    [
    {
    "valueCoding":
    {
    "system": "string",
    "code": "string",
    "display": "string"
    },
    "item":
    [
    {
    "item":
    [
    {
    "fhir_comments":
    [
    { }
    ],
    "answer":
    [
    {
    "valueCoding":
    {
    "system": "string",
    "code": "string"
    }
    }
    ]
    }
    ]
    }
    ]
    }
    ]
    }
    ]
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
authored	string <date> When the questionnaire response was last changed
author	string The author of the questionnaire response
based-on	string Plan/proposal/order fulfilled by this questionnaire response
context	string Encounter or episode associated with the questionnaire response
identifier	string The unique identifier for the questionnaire response
parent	string Procedure or observation this questionnaire response was performed as a part of
patient	string The patient that is the subject of the questionnaire response
questionnaire	string The questionnaire the answers are provided for
source	string The individual providing the information reflected in the questionnaire respose
status	string The status of the questionnaire response
subject	string The subject of the questionnaire response
_format	string

Responses

200

Success

get /QuestionnaireResponse

https://dev-pineapple-fhir.azurehealthcareapis.com/QuestionnaireResponse

<no summary>

path Parameters

required

string

Responses

200

Success

get /QuestionnaireResponse/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/QuestionnaireResponse/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
fhir_comments required	Array of objects
id required	string non-empty
text required	object
contained required	Array of objects non-empty
status required	string non-empty
subject required	object
author required	object
authored required	string non-empty
item required	Array of objects non-empty

Responses

200

Success

put /QuestionnaireResponse/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/QuestionnaireResponse/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"fhir_comments":
[
- { }
],
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"contained":
[
- {
  - "resourceType": "string",
  - "id": "string",
  - "status": "string",
  - "code":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    },
  - "subject":
    {
    "reference": "string"
    },
  - "performer":
    [
    {
    "reference": "string"
    }
    ],
  - "valueCodeableConcept":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
    }
  }
],
"status": "string",
"subject":
{
- "reference": "string"
},
"author":
{
- "reference": "string"
},
"authored": "string",
"item":
[
- {
  - "item":
    [
    {
    "fhir_comments":
    [
    { }
    ],
    "answer":
    [
    {
    "valueCoding":
    {
    "system": "string",
    "code": "string",
    "display": "string"
    },
    "item":
    [
    {
    "item":
    [
    {
    "fhir_comments":
    [
    { }
    ],
    "answer":
    [
    {
    "valueCoding":
    {
    "system": "string",
    "code": "string"
    }
    }
    ]
    }
    ]
    }
    ]
    }
    ]
    }
    ]
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /QuestionnaireResponse/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/QuestionnaireResponse/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /QuestionnaireResponse/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/QuestionnaireResponse/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /QuestionnaireResponse/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/QuestionnaireResponse/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /QuestionnaireResponse/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/QuestionnaireResponse/{id}/_history/{vid}

ReferralRequest

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
status required	string non-empty
category required	string non-empty
type required	object
priority required	object
patient required	object
authored required	string non-empty
requester required	object
specialty required	object
recipient required	Array of objects non-empty
reason required	object
description required	string non-empty
serviceRequested required	Array of objects non-empty

Responses

200

Success

post /ReferralRequest

https://dev-pineapple-fhir.azurehealthcareapis.com/ReferralRequest

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"status": "string",
"category": "string",
"type":
{
- "fhir_comments":
  [
  - { }
  ],
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"priority":
{
- "fhir_comments":
  [
  - { }
  ],
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"patient":
{
- "reference": "string",
- "display": "string"
},
"authored": "string",
"requester":
{
- "reference": "string",
- "display": "string"
},
"specialty":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"recipient":
[
- {
  - "reference": "string",
  - "display": "string"
  }
],
"reason":
{
- "text": "string"
},
"description": "string",
"serviceRequested":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ],
  - "text": "string"
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
authored-on	string <date> Creation or activation date
based-on	string Request being fulfilled
context	string Part of encounter or episode of care
definition	string Instantiates protocol or definition
encounter	string Originating encounter
group-identifier	string Part of common request
identifier	string Business identifier
intent	string Proposal, plan or order
occurrence-date	string <date> When the service(s) requested in the referral should occur
patient	string Who the referral is about
priority	string The priority assigned to the referral
recipient	string The person that the referral was sent to
replaces	string Request(s) replaced by this request
requester	string Individual making the request
service	string Actions requested as part of the referral
specialty	string The specialty that the referral is for
status	string The status of the referral
subject	string Patient referred to care or transfer
type	string The type of the referral
_format	string

Responses

200

Success

get /ReferralRequest

https://dev-pineapple-fhir.azurehealthcareapis.com/ReferralRequest

<no summary>

path Parameters

required

string

Responses

200

Success

get /ReferralRequest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ReferralRequest/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
status required	string non-empty
category required	string non-empty
type required	object
priority required	object
patient required	object
authored required	string non-empty
requester required	object
specialty required	object
recipient required	Array of objects non-empty
reason required	object
description required	string non-empty
serviceRequested required	Array of objects non-empty

Responses

200

Success

put /ReferralRequest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ReferralRequest/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"status": "string",
"category": "string",
"type":
{
- "fhir_comments":
  [
  - { }
  ],
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"priority":
{
- "fhir_comments":
  [
  - { }
  ],
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"patient":
{
- "reference": "string",
- "display": "string"
},
"authored": "string",
"requester":
{
- "reference": "string",
- "display": "string"
},
"specialty":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"recipient":
[
- {
  - "reference": "string",
  - "display": "string"
  }
],
"reason":
{
- "text": "string"
},
"description": "string",
"serviceRequested":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ],
  - "text": "string"
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /ReferralRequest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ReferralRequest/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /ReferralRequest/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ReferralRequest/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /ReferralRequest/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ReferralRequest/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /ReferralRequest/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/ReferralRequest/{id}/_history/{vid}

RelatedPerson

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
patient required	object
relationship required	object
name required	object
telecom required	Array of objects non-empty
gender required	string non-empty
address required	Array of objects non-empty
photo required	Array of objects non-empty
period required	object

Responses

200

Success

post /RelatedPerson

https://dev-pineapple-fhir.azurehealthcareapis.com/RelatedPerson

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"patient":
{
- "reference": "string"
},
"relationship":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string"
    }
  ]
},
"name":
{
- "use": "string",
- "family":
  [
  - { }
  ],
- "given":
  [
  - { }
  ]
},
"telecom":
[
- {
  - "system": "string",
  - "value": "string",
  - "use": "string"
  }
],
"gender": "string",
"address":
[
- {
  - "use": "string",
  - "line":
    [
    { }
    ],
  - "city": "string",
  - "state": "string",
  - "postalCode": "string"
  }
],
"photo":
[
- {
  - "contentType": "string",
  - "url": "string"
  }
],
"period":
{
- "start": "string"
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
active	string Indicates if the related person record is active
address-city	string A city specified in an address
address-country	string A country/region specified in an address
address-postalcode	string A postal code specified in an address
address-state	string A state specified in an address
address	string A server defined search that may match any of the string fields in the Address, including line, city, state, country/region, postalCode, and/or text
address-use	string A use code specified in an address
birthdate	string <date> The Related Person's date of birth
email	string A value in an email contact
gender	string Gender of the related person
identifier	string An Identifier of the RelatedPerson
name	string A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
patient	string The patient this related person is related to
phonetic	string A portion of name using some kind of phonetic matching algorithm
phone	string A value in a phone contact
telecom	string The value in any kind of contact
_format	string

Responses

200

Success

get /RelatedPerson

https://dev-pineapple-fhir.azurehealthcareapis.com/RelatedPerson

<no summary>

path Parameters

required

string

Responses

200

Success

get /RelatedPerson/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/RelatedPerson/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
patient required	object
relationship required	object
name required	object
telecom required	Array of objects non-empty
gender required	string non-empty
address required	Array of objects non-empty
photo required	Array of objects non-empty
period required	object

Responses

200

Success

put /RelatedPerson/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/RelatedPerson/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"patient":
{
- "reference": "string"
},
"relationship":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string"
    }
  ]
},
"name":
{
- "use": "string",
- "family":
  [
  - { }
  ],
- "given":
  [
  - { }
  ]
},
"telecom":
[
- {
  - "system": "string",
  - "value": "string",
  - "use": "string"
  }
],
"gender": "string",
"address":
[
- {
  - "use": "string",
  - "line":
    [
    { }
    ],
  - "city": "string",
  - "state": "string",
  - "postalCode": "string"
  }
],
"photo":
[
- {
  - "contentType": "string",
  - "url": "string"
  }
],
"period":
{
- "start": "string"
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /RelatedPerson/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/RelatedPerson/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /RelatedPerson/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/RelatedPerson/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /RelatedPerson/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/RelatedPerson/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /RelatedPerson/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/RelatedPerson/{id}/_history/{vid}

RequestGroup

<no summary>

Request Body schema: application/json

any (RequestGroup)

Responses

200

Success

post /RequestGroup

https://dev-pineapple-fhir.azurehealthcareapis.com/RequestGroup

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
authored	string <date> The date the request group was authored
author	string The author of the request group
context	string The context the request group applies to
definition	string The definition from which the request group is realized
encounter	string The encounter the request group applies to
group-identifier	string The group identifier for the request group
identifier	string External identifiers for the request group
intent	string The intent of the request group
participant	string The participant in the requests in the group
patient	string The identity of a patient to search for request groups
priority	string The priority of the request group
status	string The status of the request group
subject	string The subject that the request group is about
_format	string

Responses

200

Success

get /RequestGroup

https://dev-pineapple-fhir.azurehealthcareapis.com/RequestGroup

<no summary>

path Parameters

required

string

Responses

200

Success

get /RequestGroup/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/RequestGroup/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

any (RequestGroup)

Responses

200

Success

put /RequestGroup/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/RequestGroup/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

path Parameters

required

string

Responses

200

Success

delete /RequestGroup/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/RequestGroup/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /RequestGroup/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/RequestGroup/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /RequestGroup/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/RequestGroup/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /RequestGroup/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/RequestGroup/{id}/_history/{vid}

ResearchStudy

<no summary>

Request Body schema: application/json

any (ResearchStudy)

Responses

200

Success

post /ResearchStudy

https://dev-pineapple-fhir.azurehealthcareapis.com/ResearchStudy

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
category	string Classifications for the study
date	string <date> When the study began and ended
focus	string Drugs, devices, conditions, etc. under study
identifier	string Business Identifier for study
jurisdiction	string Geographic region(s) for study
keyword	string Used to search for the study
partof	string Part of larger study
principalinvestigator	string The individual responsible for the study
protocol	string Steps followed in executing study
site	string Location involved in study execution
sponsor	string Organization responsible for the study
status	string draft \| in-progress \| suspended \| stopped \| completed \| entered-in-error
title	string Name for this study
_format	string

Responses

200

Success

get /ResearchStudy

https://dev-pineapple-fhir.azurehealthcareapis.com/ResearchStudy

<no summary>

path Parameters

required

string

Responses

200

Success

get /ResearchStudy/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ResearchStudy/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

any (ResearchStudy)

Responses

200

Success

put /ResearchStudy/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ResearchStudy/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

path Parameters

required

string

Responses

200

Success

delete /ResearchStudy/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ResearchStudy/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /ResearchStudy/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ResearchStudy/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /ResearchStudy/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ResearchStudy/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /ResearchStudy/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/ResearchStudy/{id}/_history/{vid}

ResearchSubject

<no summary>

Request Body schema: application/json

any (ResearchSubject)

Responses

200

Success

post /ResearchSubject

https://dev-pineapple-fhir.azurehealthcareapis.com/ResearchSubject

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
date	string <date> Start and end of participation
identifier	string Business Identifier for research subject
individual	string Who is part of study
patient	string Who is part of study
status	string candidate \| enrolled \| active \| suspended \| withdrawn \| completed
_format	string

Responses

200

Success

get /ResearchSubject

https://dev-pineapple-fhir.azurehealthcareapis.com/ResearchSubject

<no summary>

path Parameters

required

string

Responses

200

Success

get /ResearchSubject/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ResearchSubject/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

any (ResearchSubject)

Responses

200

Success

put /ResearchSubject/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ResearchSubject/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

path Parameters

required

string

Responses

200

Success

delete /ResearchSubject/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ResearchSubject/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /ResearchSubject/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ResearchSubject/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /ResearchSubject/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ResearchSubject/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /ResearchSubject/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/ResearchSubject/{id}/_history/{vid}

RiskAssessment

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
date required	string non-empty
method required	object
basis required	Array of objects non-empty
prediction required	Array of objects non-empty

Responses

200

Success

post /RiskAssessment

https://dev-pineapple-fhir.azurehealthcareapis.com/RiskAssessment

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"date": "string",
"method":
{
- "coding":
  [
  - {
    "code": "string"
    }
  ]
},
"basis":
[
- {
  - "reference": "string"
  }
],
"prediction":
[
- {
  - "outcome":
    {
    "text": "string"
    },
  - "probabilityDecimal": 0,
  - "whenRange":
    {
    "high":
    {
    "value": 0,
    "unit": "string",
    "system": "string",
    "code": "string"
    }
    }
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
condition	string Condition assessed
date	string <date> When was assessment made?
encounter	string Where was assessment performed?
identifier	string Unique identifier for the assessment
method	string Evaluation mechanism
patient	string Who/what does assessment apply to?
performer	string Who did assessment?
probability	number Likelihood of specified outcome
risk	string Likelihood of specified outcome as a qualitative value
subject	string Who/what does assessment apply to?
_format	string

Responses

200

Success

get /RiskAssessment

https://dev-pineapple-fhir.azurehealthcareapis.com/RiskAssessment

<no summary>

path Parameters

required

string

Responses

200

Success

get /RiskAssessment/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/RiskAssessment/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
date required	string non-empty
method required	object
basis required	Array of objects non-empty
prediction required	Array of objects non-empty

Responses

200

Success

put /RiskAssessment/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/RiskAssessment/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"date": "string",
"method":
{
- "coding":
  [
  - {
    "code": "string"
    }
  ]
},
"basis":
[
- {
  - "reference": "string"
  }
],
"prediction":
[
- {
  - "outcome":
    {
    "text": "string"
    },
  - "probabilityDecimal": 0,
  - "whenRange":
    {
    "high":
    {
    "value": 0,
    "unit": "string",
    "system": "string",
    "code": "string"
    }
    }
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /RiskAssessment/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/RiskAssessment/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /RiskAssessment/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/RiskAssessment/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /RiskAssessment/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/RiskAssessment/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /RiskAssessment/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/RiskAssessment/{id}/_history/{vid}

Schedule

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
serviceCategory required	object
serviceType required	Array of objects non-empty
specialty required	Array of objects non-empty
actor required	object
planningHorizon required	object
comment required	string non-empty

Responses

200

Success

post /Schedule

https://dev-pineapple-fhir.azurehealthcareapis.com/Schedule

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "use": "string",
  - "system": "string",
  - "value": "string"
  }
],
"serviceCategory":
{
- "coding":
  [
  - {
    "code": "string",
    "display": "string"
    }
  ]
},
"serviceType":
[
- {
  - "coding":
    [
    {
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"specialty":
[
- {
  - "coding":
    [
    {
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"actor":
{
- "reference": "string",
- "display": "string"
},
"planningHorizon":
{
- "start": "string",
- "end": "string"
},
"comment": "string"

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
active	string Is the schedule in active use
actor	string The individual(HealthcareService, Practitioner, Location, ...) to find a Schedule for
date	string <date> Search for Schedule resources that have a period that contains this date specified
identifier	string A Schedule Identifier
type	string The type of appointments that can be booked into associated slot(s)
_format	string

Responses

200

Success

get /Schedule

https://dev-pineapple-fhir.azurehealthcareapis.com/Schedule

<no summary>

path Parameters

required

string

Responses

200

Success

get /Schedule/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Schedule/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
serviceCategory required	object
serviceType required	Array of objects non-empty
specialty required	Array of objects non-empty
actor required	object
planningHorizon required	object
comment required	string non-empty

Responses

200

Success

put /Schedule/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Schedule/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "use": "string",
  - "system": "string",
  - "value": "string"
  }
],
"serviceCategory":
{
- "coding":
  [
  - {
    "code": "string",
    "display": "string"
    }
  ]
},
"serviceType":
[
- {
  - "coding":
    [
    {
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"specialty":
[
- {
  - "coding":
    [
    {
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"actor":
{
- "reference": "string",
- "display": "string"
},
"planningHorizon":
{
- "start": "string",
- "end": "string"
},
"comment": "string"

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Schedule/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Schedule/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Schedule/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Schedule/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Schedule/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Schedule/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Schedule/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Schedule/{id}/_history/{vid}

SearchParameter

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
url required	string non-empty
name required	string non-empty
status required	string non-empty
experimental required	boolean
date required	string non-empty
publisher required	string non-empty
contact required	Array of objects non-empty
requirements required	string non-empty
_requirements required	object
code required	string non-empty
base required	string non-empty
type required	string non-empty
description required	string non-empty
xpath required	string non-empty
xpathUsage required	string non-empty

Responses

200

Success

post /SearchParameter

https://dev-pineapple-fhir.azurehealthcareapis.com/SearchParameter

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"url": "string",
"name": "string",
"status": "string",
"experimental": true,
"date": "string",
"publisher": "string",
"contact":
[
- {
  - "name": "string",
  - "telecom":
    [
    {
    "fhir_comments":
    [
    { }
    ],
    "system": "string",
    "value": "string"
    }
    ]
  }
],
"requirements": "string",
"_requirements":
{
- "fhir_comments":
  [
  - { }
  ]
},
"code": "string",
"base": "string",
"type": "string",
"description": "string",
"xpath": "string",
"xpathUsage": "string"

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
base	string The resource type(s) this search parameter applies to
code	string Code used in URL
component	string Defines how the part works
date	string <date> The search parameter publication date
derived-from	string Original Definition for the search parameter
description	string The description of the search parameter
jurisdiction	string Intended jurisdiction for the search parameter
name	string Computationally friendly name of the search parameter
publisher	string Name of the publisher of the search parameter
status	string The current status of the search parameter
target	string Types of resource (if a resource reference)
type	string number \| date \| string \| token \| reference \| composite \| quantity \| uri
url	string The uri that identifies the search parameter
version	string The business version of the search parameter
_format	string

Responses

200

Success

get /SearchParameter

https://dev-pineapple-fhir.azurehealthcareapis.com/SearchParameter

<no summary>

path Parameters

required

string

Responses

200

Success

get /SearchParameter/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/SearchParameter/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
url required	string non-empty
name required	string non-empty
status required	string non-empty
experimental required	boolean
date required	string non-empty
publisher required	string non-empty
contact required	Array of objects non-empty
requirements required	string non-empty
_requirements required	object
code required	string non-empty
base required	string non-empty
type required	string non-empty
description required	string non-empty
xpath required	string non-empty
xpathUsage required	string non-empty

Responses

200

Success

put /SearchParameter/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/SearchParameter/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"url": "string",
"name": "string",
"status": "string",
"experimental": true,
"date": "string",
"publisher": "string",
"contact":
[
- {
  - "name": "string",
  - "telecom":
    [
    {
    "fhir_comments":
    [
    { }
    ],
    "system": "string",
    "value": "string"
    }
    ]
  }
],
"requirements": "string",
"_requirements":
{
- "fhir_comments":
  [
  - { }
  ]
},
"code": "string",
"base": "string",
"type": "string",
"description": "string",
"xpath": "string",
"xpathUsage": "string"

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /SearchParameter/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/SearchParameter/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /SearchParameter/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/SearchParameter/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /SearchParameter/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/SearchParameter/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /SearchParameter/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/SearchParameter/{id}/_history/{vid}

Sequence

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
type required	string non-empty
patient required	object
species required	object
referenceSeq required	Array of objects non-empty
variation required	object
repository required	Array of objects non-empty

Responses

200

Success

post /Sequence

https://dev-pineapple-fhir.azurehealthcareapis.com/Sequence

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"type": "string",
"patient":
{
- "reference": "string"
},
"species":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string"
    }
  ],
- "text": "string"
},
"referenceSeq":
[
- {
  - "referenceSeqId":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
    },
  - "windowStart": 0,
  - "windowEnd": 0
  }
],
"variation":
{
- "start": 0,
- "end": 0,
- "observedAllele": "string",
- "referenceAllele": "string"
},
"repository":
[
- {
  - "url": "string",
  - "name": "string",
  - "variantId": "string"
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
chromosome	string Chromosome number of the reference sequence
coordinate	string Search parameter for region of the reference DNA sequence string. This will refer to part of a locus or part of a gene where search region will be represented in 1-based system. Since the coordinateSystem can either be 0-based or 1-based, this search query will include the result of both coordinateSystem that contains the equivalent segment of the gene or whole genome sequence. For example, a search for sequence can be represented as `coordinate=1$lt345$gt123`, this means it will search for the Sequence resource on chromosome 1 and with position >123 and <345, where in 1-based system resource, all strings within region 1:124-344 will be revealed, while in 0-based system resource, all strings within region 1:123-344 will be revealed. You may want to check detail about 0-based v.s. 1-based above.
end	number End position (0-based exclusive, which menas the acid at this position will not be included, 1-based inclusive, which means the acid at this position will be included) of the reference sequence.
identifier	string The unique identity for a particular sequence
patient	string The subject that the observation is about
start	number Start position (0-based inclusive, 1-based inclusive, that means the nucleic acid or amino acid at this position will be included) of the reference sequence.
type	string Amino Acid Sequence/ DNA Sequence / RNA Sequence
_format	string

Responses

200

Success

get /Sequence

https://dev-pineapple-fhir.azurehealthcareapis.com/Sequence

<no summary>

path Parameters

required

string

Responses

200

Success

get /Sequence/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Sequence/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
type required	string non-empty
patient required	object
species required	object
referenceSeq required	Array of objects non-empty
variation required	object
repository required	Array of objects non-empty

Responses

200

Success

put /Sequence/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Sequence/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"type": "string",
"patient":
{
- "reference": "string"
},
"species":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string"
    }
  ],
- "text": "string"
},
"referenceSeq":
[
- {
  - "referenceSeqId":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
    },
  - "windowStart": 0,
  - "windowEnd": 0
  }
],
"variation":
{
- "start": 0,
- "end": 0,
- "observedAllele": "string",
- "referenceAllele": "string"
},
"repository":
[
- {
  - "url": "string",
  - "name": "string",
  - "variantId": "string"
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Sequence/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Sequence/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Sequence/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Sequence/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Sequence/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Sequence/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Sequence/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Sequence/{id}/_history/{vid}

ServiceDefinition

<no summary>

Request Body schema: application/json

any (ServiceDefinition)

Responses

200

Success

post /ServiceDefinition

https://dev-pineapple-fhir.azurehealthcareapis.com/ServiceDefinition

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
composed-of	string What resource is being referenced
date	string <date> The service definition publication date
depends-on	string What resource is being referenced
derived-from	string What resource is being referenced
description	string The description of the service definition
effective	string <date> The time during which the service definition is intended to be in use
identifier	string External identifier for the service definition
jurisdiction	string Intended jurisdiction for the service definition
name	string Computationally friendly name of the service definition
predecessor	string What resource is being referenced
publisher	string Name of the publisher of the service definition
status	string The current status of the service definition
successor	string What resource is being referenced
title	string The human-friendly name of the service definition
topic	string Topics associated with the module
url	string The uri that identifies the service definition
version	string The business version of the service definition
_format	string

Responses

200

Success

get /ServiceDefinition

https://dev-pineapple-fhir.azurehealthcareapis.com/ServiceDefinition

<no summary>

path Parameters

required

string

Responses

200

Success

get /ServiceDefinition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ServiceDefinition/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

any (ServiceDefinition)

Responses

200

Success

put /ServiceDefinition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ServiceDefinition/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

path Parameters

required

string

Responses

200

Success

delete /ServiceDefinition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ServiceDefinition/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /ServiceDefinition/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ServiceDefinition/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /ServiceDefinition/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ServiceDefinition/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /ServiceDefinition/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/ServiceDefinition/{id}/_history/{vid}

Slot

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
serviceCategory required	object
serviceType required	Array of objects non-empty
specialty required	Array of objects non-empty
appointmentType required	object
schedule required	object
status required	string non-empty
start required	string non-empty
end required	string non-empty
comment required	string non-empty

Responses

200

Success

post /Slot

https://dev-pineapple-fhir.azurehealthcareapis.com/Slot

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"serviceCategory":
{
- "coding":
  [
  - {
    "code": "string",
    "display": "string"
    }
  ]
},
"serviceType":
[
- {
  - "coding":
    [
    {
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"specialty":
[
- {
  - "coding":
    [
    {
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"appointmentType":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"schedule":
{
- "reference": "string"
},
"status": "string",
"start": "string",
"end": "string",
"comment": "string"

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
identifier	string A Slot Identifier
schedule	string The Schedule Resource that we are seeking a slot within
slot-type	string The type of appointments that can be booked into the slot
start	string <date> Appointment date/time.
status	string The free/busy status of the appointment
_format	string

Responses

200

Success

get /Slot

https://dev-pineapple-fhir.azurehealthcareapis.com/Slot

<no summary>

path Parameters

required

string

Responses

200

Success

get /Slot/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Slot/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
serviceCategory required	object
serviceType required	Array of objects non-empty
specialty required	Array of objects non-empty
appointmentType required	object
schedule required	object
status required	string non-empty
start required	string non-empty
end required	string non-empty
comment required	string non-empty

Responses

200

Success

put /Slot/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Slot/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"serviceCategory":
{
- "coding":
  [
  - {
    "code": "string",
    "display": "string"
    }
  ]
},
"serviceType":
[
- {
  - "coding":
    [
    {
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"specialty":
[
- {
  - "coding":
    [
    {
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"appointmentType":
{
- "coding":
  [
  - {
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"schedule":
{
- "reference": "string"
},
"status": "string",
"start": "string",
"end": "string",
"comment": "string"

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Slot/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Slot/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Slot/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Slot/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Slot/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Slot/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Slot/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Slot/{id}/_history/{vid}

Specimen

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
contained required	Array of objects non-empty
identifier required	Array of objects non-empty
accessionIdentifier required	object
status required	string non-empty
type required	object
subject required	object
receivedTime required	string non-empty
collection required	object
container required	Array of objects non-empty

Responses

200

Success

post /Specimen

https://dev-pineapple-fhir.azurehealthcareapis.com/Specimen

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "fhir_comments":
  [
  - { }
  ],
- "status": "string",
- "div": "string"
},
"contained":
[
- {
  - "resourceType": "string",
  - "id": "string",
  - "code":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
    }
  }
],
"identifier":
[
- {
  - "system": "string",
  - "_system":
    {
    "fhir_comments":
    [
    { }
    ]
    },
  - "value": "string"
  }
],
"accessionIdentifier":
{
- "system": "string",
- "value": "string"
},
"status": "string",
"type":
{
- "coding":
  [
  - {
    "fhir_comments":
    [
    { }
    ],
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"subject":
{
- "reference": "string",
- "display": "string"
},
"receivedTime": "string",
"collection":
{
- "collector":
  {
  - "reference": "string",
  - "_reference":
    {
    "fhir_comments":
    [
    { }
    ]
    }
  },
- "comment": "string",
- "collectedDateTime": "string",
- "_collectedDateTime":
  {
  - "fhir_comments":
    [
    { }
    ]
  },
- "quantity":
  {
  - "fhir_comments":
    [
    { }
    ],
  - "value": 0,
  - "unit": "string"
  },
- "method":
  {
  - "fhir_comments":
    [
    { }
    ],
  - "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
  }
},
"container":
[
- {
  - "identifier":
    [
    {
    "fhir_comments":
    [
    { }
    ],
    "value": "string",
    "_value":
    {
    "fhir_comments":
    [
    { }
    ]
    }
    }
    ],
  - "description": "string",
  - "type":
    {
    "text": "string",
    "_text":
    {
    "fhir_comments":
    [
    { }
    ]
    }
    },
  - "capacity":
    {
    "value": 0,
    "unit": "string"
    },
  - "specimenQuantity":
    {
    "fhir_comments":
    [
    { }
    ],
    "value": 0,
    "unit": "string"
    },
  - "additiveReference":
    {
    "reference": "string"
    }
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
accession	string The accession number associated with the specimen
bodysite	string The code for the body site from where the specimen originated
collected	string <date> The date the specimen was collected
collector	string Who collected the specimen
container-id	string The unique identifier associated with the specimen container
container	string The kind of specimen container
identifier	string The unique identifier associated with the specimen
parent	string The parent of the specimen
patient	string The patient the specimen comes from
status	string available \| unavailable \| unsatisfactory \| entered-in-error
subject	string The subject of the specimen
type	string The specimen type
_format	string

Responses

200

Success

get /Specimen

https://dev-pineapple-fhir.azurehealthcareapis.com/Specimen

<no summary>

path Parameters

required

string

Responses

200

Success

get /Specimen/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Specimen/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
contained required	Array of objects non-empty
identifier required	Array of objects non-empty
accessionIdentifier required	object
status required	string non-empty
type required	object
subject required	object
receivedTime required	string non-empty
collection required	object
container required	Array of objects non-empty

Responses

200

Success

put /Specimen/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Specimen/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "fhir_comments":
  [
  - { }
  ],
- "status": "string",
- "div": "string"
},
"contained":
[
- {
  - "resourceType": "string",
  - "id": "string",
  - "code":
    {
    "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
    }
  }
],
"identifier":
[
- {
  - "system": "string",
  - "_system":
    {
    "fhir_comments":
    [
    { }
    ]
    },
  - "value": "string"
  }
],
"accessionIdentifier":
{
- "system": "string",
- "value": "string"
},
"status": "string",
"type":
{
- "coding":
  [
  - {
    "fhir_comments":
    [
    { }
    ],
    "system": "string",
    "code": "string",
    "display": "string"
    }
  ]
},
"subject":
{
- "reference": "string",
- "display": "string"
},
"receivedTime": "string",
"collection":
{
- "collector":
  {
  - "reference": "string",
  - "_reference":
    {
    "fhir_comments":
    [
    { }
    ]
    }
  },
- "comment": "string",
- "collectedDateTime": "string",
- "_collectedDateTime":
  {
  - "fhir_comments":
    [
    { }
    ]
  },
- "quantity":
  {
  - "fhir_comments":
    [
    { }
    ],
  - "value": 0,
  - "unit": "string"
  },
- "method":
  {
  - "fhir_comments":
    [
    { }
    ],
  - "coding":
    [
    {
    "system": "string",
    "code": "string"
    }
    ]
  }
},
"container":
[
- {
  - "identifier":
    [
    {
    "fhir_comments":
    [
    { }
    ],
    "value": "string",
    "_value":
    {
    "fhir_comments":
    [
    { }
    ]
    }
    }
    ],
  - "description": "string",
  - "type":
    {
    "text": "string",
    "_text":
    {
    "fhir_comments":
    [
    { }
    ]
    }
    },
  - "capacity":
    {
    "value": 0,
    "unit": "string"
    },
  - "specimenQuantity":
    {
    "fhir_comments":
    [
    { }
    ],
    "value": 0,
    "unit": "string"
    },
  - "additiveReference":
    {
    "reference": "string"
    }
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Specimen/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Specimen/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Specimen/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Specimen/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Specimen/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Specimen/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Specimen/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Specimen/{id}/_history/{vid}

StructureDefinition

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
url required	string non-empty
identifier required	Array of objects non-empty
version required	string non-empty
name required	string non-empty
display required	string non-empty
_display required	object
status required	string non-empty
experimental required	boolean
publisher required	string non-empty
contact required	Array of objects non-empty
date required	string non-empty
description required	string non-empty
useContext required	Array of objects non-empty
requirements required	string non-empty
copyright required	string non-empty
_copyright required	object
code required	Array of objects non-empty
fhirVersion required	string non-empty
mapping required	Array of objects non-empty
kind required	string non-empty
abstract required	boolean
baseType required	string non-empty
baseDefinition required	string non-empty
derivation required	string non-empty
snapshot required	object

Responses

200

Success

post /StructureDefinition

https://dev-pineapple-fhir.azurehealthcareapis.com/StructureDefinition

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"url": "string",
"identifier":
[
- {
  - "system": "string",
  - "_system":
    {
    "fhir_comments":
    [
    { }
    ]
    },
  - "value": "string"
  }
],
"version": "string",
"name": "string",
"display": "string",
"_display":
{
- "fhir_comments":
  [
  - { }
  ]
},
"status": "string",
"experimental": true,
"publisher": "string",
"contact":
[
- {
  - "name": "string",
  - "telecom":
    [
    {
    "system": "string",
    "value": "string"
    }
    ]
  }
],
"date": "string",
"description": "string",
"useContext":
[
- {
  - "coding":
    [
    {
    "fhir_comments":
    [
    { }
    ],
    "system": "string",
    "code": "string"
    }
    ]
  }
],
"requirements": "string",
"copyright": "string",
"_copyright":
{
- "fhir_comments":
  [
  - { }
  ]
},
"code":
[
- {
  - "system": "string",
  - "code": "string",
  - "display": "string"
  }
],
"fhirVersion": "string",
"mapping":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "identity": "string",
  - "uri": "string",
  - "name": "string",
  - "comments": "string"
  }
],
"kind": "string",
"abstract": true,
"baseType": "string",
"baseDefinition": "string",
"derivation": "string",
"snapshot":
{
- "element":
  [
  - {
    "path": "string",
    "name": "string",
    "short": "string",
    "definition": "string",
    "comments": "string",
    "min": 0,
    "max": "string",
    "base":
    {
    "path": "string",
    "min": 0,
    "max": "string"
    },
    "type":
    [
    {
    "code": "string"
    }
    ],
    "isModifier": true
    }
  ]
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
abstract	string Whether the structure is abstract
base-path	string Path that identifies the base element
base	string Definition that this type is constrained/specialized from
context-type	string resource \| datatype \| extension
date	string <date> The structure definition publication date
derivation	string specialization \| constraint - How relates to base definition
description	string The description of the structure definition
experimental	string For testing purposes, not real usage
ext-context	string Where the extension can be used in instances
identifier	string External identifier for the structure definition
jurisdiction	string Intended jurisdiction for the structure definition
keyword	string A code for the profile
kind	string primitive-type \| complex-type \| resource \| logical
name	string Computationally friendly name of the structure definition
path	string A path that is constrained in the profile
publisher	string Name of the publisher of the structure definition
status	string The current status of the structure definition
title	string The human-friendly name of the structure definition
type	string Type defined or constrained by this structure
url	string The uri that identifies the structure definition
valueset	string A vocabulary binding reference
version	string The business version of the structure definition
_format	string

Responses

200

Success

get /StructureDefinition

https://dev-pineapple-fhir.azurehealthcareapis.com/StructureDefinition

<no summary>

path Parameters

required

string

Responses

200

Success

get /StructureDefinition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/StructureDefinition/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
url required	string non-empty
identifier required	Array of objects non-empty
version required	string non-empty
name required	string non-empty
display required	string non-empty
_display required	object
status required	string non-empty
experimental required	boolean
publisher required	string non-empty
contact required	Array of objects non-empty
date required	string non-empty
description required	string non-empty
useContext required	Array of objects non-empty
requirements required	string non-empty
copyright required	string non-empty
_copyright required	object
code required	Array of objects non-empty
fhirVersion required	string non-empty
mapping required	Array of objects non-empty
kind required	string non-empty
abstract required	boolean
baseType required	string non-empty
baseDefinition required	string non-empty
derivation required	string non-empty
snapshot required	object

Responses

200

Success

put /StructureDefinition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/StructureDefinition/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"url": "string",
"identifier":
[
- {
  - "system": "string",
  - "_system":
    {
    "fhir_comments":
    [
    { }
    ]
    },
  - "value": "string"
  }
],
"version": "string",
"name": "string",
"display": "string",
"_display":
{
- "fhir_comments":
  [
  - { }
  ]
},
"status": "string",
"experimental": true,
"publisher": "string",
"contact":
[
- {
  - "name": "string",
  - "telecom":
    [
    {
    "system": "string",
    "value": "string"
    }
    ]
  }
],
"date": "string",
"description": "string",
"useContext":
[
- {
  - "coding":
    [
    {
    "fhir_comments":
    [
    { }
    ],
    "system": "string",
    "code": "string"
    }
    ]
  }
],
"requirements": "string",
"copyright": "string",
"_copyright":
{
- "fhir_comments":
  [
  - { }
  ]
},
"code":
[
- {
  - "system": "string",
  - "code": "string",
  - "display": "string"
  }
],
"fhirVersion": "string",
"mapping":
[
- {
  - "fhir_comments":
    [
    { }
    ],
  - "identity": "string",
  - "uri": "string",
  - "name": "string",
  - "comments": "string"
  }
],
"kind": "string",
"abstract": true,
"baseType": "string",
"baseDefinition": "string",
"derivation": "string",
"snapshot":
{
- "element":
  [
  - {
    "path": "string",
    "name": "string",
    "short": "string",
    "definition": "string",
    "comments": "string",
    "min": 0,
    "max": "string",
    "base":
    {
    "path": "string",
    "min": 0,
    "max": "string"
    },
    "type":
    [
    {
    "code": "string"
    }
    ],
    "isModifier": true
    }
  ]
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /StructureDefinition/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/StructureDefinition/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /StructureDefinition/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/StructureDefinition/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /StructureDefinition/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/StructureDefinition/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /StructureDefinition/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/StructureDefinition/{id}/_history/{vid}

StructureMap

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
url required	string non-empty
name required	string non-empty
status required	string non-empty
group required	Array of objects non-empty

Responses

200

Success

post /StructureMap

https://dev-pineapple-fhir.azurehealthcareapis.com/StructureMap

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"url": "string",
"name": "string",
"status": "string",
"group":
[
- {
  - "name": "string",
  - "input":
    [
    {
    "name": "string",
    "mode": "string"
    }
    ],
  - "rule":
    [
    {
    "name": "string",
    "source":
    [
    {
    "required": true,
    "context": "string",
    "contextType": "string",
    "element": "string",
    "variable": "string"
    }
    ]
    }
    ]
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
date	string <date> The structure map publication date
description	string The description of the structure map
identifier	string External identifier for the structure map
jurisdiction	string Intended jurisdiction for the structure map
name	string Computationally friendly name of the structure map
publisher	string Name of the publisher of the structure map
status	string The current status of the structure map
title	string The human-friendly name of the structure map
url	string The uri that identifies the structure map
version	string The business version of the structure map
_format	string

Responses

200

Success

get /StructureMap

https://dev-pineapple-fhir.azurehealthcareapis.com/StructureMap

<no summary>

path Parameters

required

string

Responses

200

Success

get /StructureMap/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/StructureMap/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
url required	string non-empty
name required	string non-empty
status required	string non-empty
group required	Array of objects non-empty

Responses

200

Success

put /StructureMap/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/StructureMap/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"url": "string",
"name": "string",
"status": "string",
"group":
[
- {
  - "name": "string",
  - "input":
    [
    {
    "name": "string",
    "mode": "string"
    }
    ],
  - "rule":
    [
    {
    "name": "string",
    "source":
    [
    {
    "required": true,
    "context": "string",
    "contextType": "string",
    "element": "string",
    "variable": "string"
    }
    ]
    }
    ]
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /StructureMap/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/StructureMap/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /StructureMap/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/StructureMap/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /StructureMap/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/StructureMap/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /StructureMap/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/StructureMap/{id}/_history/{vid}

Subscription

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
criteria required	string non-empty
contact required	Array of objects non-empty
reason required	string non-empty
status required	string non-empty
channel required	object
end required	string non-empty
tag required	Array of objects non-empty

Responses

200

Success

post /Subscription

https://dev-pineapple-fhir.azurehealthcareapis.com/Subscription

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"criteria": "string",
"contact":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"reason": "string",
"status": "string",
"channel":
{
- "type": "string",
- "endpoint": "string",
- "payload": "string",
- "header": "string"
},
"end": "string",
"tag":
[
- {
  - "system": "string",
  - "code": "string"
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
add-tag	string A tag to be added to the resource matching the criteria
contact	string Contact details for the subscription
criteria	string The search rules used to determine when to send a notification
payload	string The mime-type of the notification payload
status	string The current state of the subscription
type	string The type of channel for the sent notifications
url	string The uri that will receive the notifications
_format	string

Responses

200

Success

get /Subscription

https://dev-pineapple-fhir.azurehealthcareapis.com/Subscription

<no summary>

path Parameters

required

string

Responses

200

Success

get /Subscription/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Subscription/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
criteria required	string non-empty
contact required	Array of objects non-empty
reason required	string non-empty
status required	string non-empty
channel required	object
end required	string non-empty
tag required	Array of objects non-empty

Responses

200

Success

put /Subscription/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Subscription/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"criteria": "string",
"contact":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"reason": "string",
"status": "string",
"channel":
{
- "type": "string",
- "endpoint": "string",
- "payload": "string",
- "header": "string"
},
"end": "string",
"tag":
[
- {
  - "system": "string",
  - "code": "string"
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Subscription/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Subscription/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Subscription/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Subscription/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Subscription/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Subscription/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Subscription/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Subscription/{id}/_history/{vid}

Substance

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
category required	Array of objects non-empty
code required	object

Responses

200

Success

post /Substance

https://dev-pineapple-fhir.azurehealthcareapis.com/Substance

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "fhir_comments":
  [
  - { }
  ],
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"category":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"code":
{
- "text": "string"
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
category	string The category of the substance
code	string The code of the substance or ingredient
container-identifier	string Identifier of the package/container
expiry	string <date> Expiry date of package or container of substance
identifier	string Unique identifier for the substance
quantity	integer Amount of substance in the package
status	string active \| inactive \| entered-in-error
substance-reference	string A component of the substance
_format	string

Responses

200

Success

get /Substance

https://dev-pineapple-fhir.azurehealthcareapis.com/Substance

<no summary>

path Parameters

required

string

Responses

200

Success

get /Substance/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Substance/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
category required	Array of objects non-empty
code required	object

Responses

200

Success

put /Substance/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Substance/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "fhir_comments":
  [
  - { }
  ],
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"category":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"code":
{
- "text": "string"
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Substance/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Substance/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Substance/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Substance/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Substance/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Substance/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Substance/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Substance/{id}/_history/{vid}

SupplyDelivery

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
fhir_comments required	Array of objects
id required	string non-empty
text required	object

Responses

200

Success

post /SupplyDelivery

https://dev-pineapple-fhir.azurehealthcareapis.com/SupplyDelivery

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"fhir_comments":
[
- { }
],
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
identifier	string External identifier
patient	string Patient for whom the item is supplied
receiver	string Who collected the Supply
status	string in-progress \| completed \| abandoned \| entered-in-error
supplier	string Dispenser
_format	string

Responses

200

Success

get /SupplyDelivery

https://dev-pineapple-fhir.azurehealthcareapis.com/SupplyDelivery

<no summary>

path Parameters

required

string

Responses

200

Success

get /SupplyDelivery/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/SupplyDelivery/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
fhir_comments required	Array of objects
id required	string non-empty
text required	object

Responses

200

Success

put /SupplyDelivery/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/SupplyDelivery/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"fhir_comments":
[
- { }
],
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /SupplyDelivery/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/SupplyDelivery/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /SupplyDelivery/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/SupplyDelivery/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /SupplyDelivery/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/SupplyDelivery/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /SupplyDelivery/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/SupplyDelivery/{id}/_history/{vid}

SupplyRequest

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
fhir_comments required	Array of objects
id required	string non-empty
text required	object

Responses

200

Success

post /SupplyRequest

https://dev-pineapple-fhir.azurehealthcareapis.com/SupplyRequest

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"fhir_comments":
[
- { }
],
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
category	string The kind of supply (central, non-stock, etc.)
date	string <date> When the request was made
identifier	string Unique identifier
requester	string Individual making the request
status	string draft \| active \| suspended +
supplier	string Who is intended to fulfill the request
_format	string

Responses

200

Success

get /SupplyRequest

https://dev-pineapple-fhir.azurehealthcareapis.com/SupplyRequest

<no summary>

path Parameters

required

string

Responses

200

Success

get /SupplyRequest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/SupplyRequest/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
fhir_comments required	Array of objects
id required	string non-empty
text required	object

Responses

200

Success

put /SupplyRequest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/SupplyRequest/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"fhir_comments":
[
- { }
],
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /SupplyRequest/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/SupplyRequest/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /SupplyRequest/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/SupplyRequest/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /SupplyRequest/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/SupplyRequest/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /SupplyRequest/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/SupplyRequest/{id}/_history/{vid}

Task

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
type required	object
status required	string non-empty
subject required	object
created required	string non-empty
lastModified required	string non-empty
creator required	object
owner required	object

Responses

200

Success

post /Task

https://dev-pineapple-fhir.azurehealthcareapis.com/Task

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"type":
{
- "text": "string"
},
"status": "string",
"subject":
{
- "reference": "string"
},
"created": "string",
"lastModified": "string",
"creator":
{
- "reference": "string"
},
"owner":
{
- "reference": "string"
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
authored-on	string <date> Search by creation date
based-on	string Search by requests this task is based on
business-status	string Search by business status
code	string Search by task code
context	string Search by encounter or episode
focus	string Search by task focus
group-identifier	string Search by group identifier
identifier	string Search for a task instance by its business identifier
intent	string Search by task intent
modified	string <date> Search by last modification date
organization	string Search by responsible organization
owner	string Search by task owner
part-of	string Search by task this task is part of
patient	string Search by patient
performer	string Search by recommended type of performer (e.g., Requester, Performer, Scheduler).
period	string <date> Search by period Task is/was underway
priority	string Search by task priority
requester	string Search by task requester
status	string Search by task status
subject	string Search by subject
_format	string

Responses

200

Success

get /Task

https://dev-pineapple-fhir.azurehealthcareapis.com/Task

<no summary>

path Parameters

required

string

Responses

200

Success

get /Task/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Task/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
type required	object
status required	string non-empty
subject required	object
created required	string non-empty
lastModified required	string non-empty
creator required	object
owner required	object

Responses

200

Success

put /Task/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Task/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"type":
{
- "text": "string"
},
"status": "string",
"subject":
{
- "reference": "string"
},
"created": "string",
"lastModified": "string",
"creator":
{
- "reference": "string"
},
"owner":
{
- "reference": "string"
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /Task/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/Task/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /Task/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Task/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /Task/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/Task/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /Task/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/Task/{id}/_history/{vid}

TestReport

<no summary>

Request Body schema: application/json

any (TestReport)

Responses

200

Success

post /TestReport

https://dev-pineapple-fhir.azurehealthcareapis.com/TestReport

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
identifier	string An external identifier for the test report
issued	string <date> The test report generation date
participant	string The reference to a participant in the test execution
result	string The result disposition of the test execution
tester	string The name of the testing organization
testscript	string The test script executed to produce this report
_format	string

Responses

200

Success

get /TestReport

https://dev-pineapple-fhir.azurehealthcareapis.com/TestReport

<no summary>

path Parameters

required

string

Responses

200

Success

get /TestReport/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/TestReport/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

any (TestReport)

Responses

200

Success

put /TestReport/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/TestReport/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

null

<no summary>

path Parameters

required

string

Responses

200

Success

delete /TestReport/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/TestReport/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /TestReport/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/TestReport/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /TestReport/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/TestReport/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /TestReport/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/TestReport/{id}/_history/{vid}

TestScript

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
url required	string non-empty
version required	string non-empty
name required	string non-empty
status required	string non-empty
identifier required	object
experimental required	boolean
publisher required	string non-empty
contact required	Array of objects non-empty
date required	string non-empty
description required	string non-empty
useContext required	Array of objects non-empty
requirements required	string non-empty
copyright required	string non-empty
metadata required	object
fixture required	Array of objects non-empty
profile required	Array of objects non-empty
setup required	object
test required	Array of objects non-empty

Responses

200

Success

post /TestScript

https://dev-pineapple-fhir.azurehealthcareapis.com/TestScript

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"url": "string",
"version": "string",
"name": "string",
"status": "string",
"identifier":
{
- "system": "string",
- "value": "string"
},
"experimental": true,
"publisher": "string",
"contact":
[
- {
  - "name": "string",
  - "telecom":
    [
    {
    "system": "string",
    "value": "string",
    "use": "string"
    }
    ]
  }
],
"date": "string",
"description": "string",
"useContext":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"requirements": "string",
"copyright": "string",
"metadata":
{
- "capability":
  [
  - {
    "required": true,
    "description": "string",
    "destination": 0,
    "link":
    [
    { }
    ],
    "conformance":
    {
    "reference": "string"
    }
    }
  ]
},
"fixture":
[
- {
  - "id": "string",
  - "autocreate": true,
  - "autodelete": true,
  - "resource":
    {
    "reference": "string",
    "display": "string"
    }
  }
],
"profile":
[
- {
  - "id": "string",
  - "reference": "string"
  }
],
"setup":
{
- "action":
  [
  - {
    "fhir_comments":
    [
    { }
    ],
    "operation":
    {
    "type":
    {
    "code": "string"
    },
    "label": "string",
    "description": "string",
    "accept": "string",
    "responseId": "string",
    "sourceId": "string"
    }
    }
  ]
},
"test":
[
- {
  - "id": "string",
  - "name": "string",
  - "description": "string",
  - "action":
    [
    {
    "operation":
    {
    "type":
    {
    "code": "string"
    },
    "encodeRequestUrl": true,
    "responseId": "string",
    "targetId": "string"
    }
    }
    ]
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
date	string <date> The test script publication date
description	string The description of the test script
identifier	string External identifier for the test script
jurisdiction	string Intended jurisdiction for the test script
name	string Computationally friendly name of the test script
publisher	string Name of the publisher of the test script
status	string The current status of the test script
testscript-capability	string TestScript required and validated capability
title	string The human-friendly name of the test script
url	string The uri that identifies the test script
version	string The business version of the test script
_format	string

Responses

200

Success

get /TestScript

https://dev-pineapple-fhir.azurehealthcareapis.com/TestScript

<no summary>

path Parameters

required

string

Responses

200

Success

get /TestScript/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/TestScript/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
url required	string non-empty
version required	string non-empty
name required	string non-empty
status required	string non-empty
identifier required	object
experimental required	boolean
publisher required	string non-empty
contact required	Array of objects non-empty
date required	string non-empty
description required	string non-empty
useContext required	Array of objects non-empty
requirements required	string non-empty
copyright required	string non-empty
metadata required	object
fixture required	Array of objects non-empty
profile required	Array of objects non-empty
setup required	object
test required	Array of objects non-empty

Responses

200

Success

put /TestScript/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/TestScript/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"url": "string",
"version": "string",
"name": "string",
"status": "string",
"identifier":
{
- "system": "string",
- "value": "string"
},
"experimental": true,
"publisher": "string",
"contact":
[
- {
  - "name": "string",
  - "telecom":
    [
    {
    "system": "string",
    "value": "string",
    "use": "string"
    }
    ]
  }
],
"date": "string",
"description": "string",
"useContext":
[
- {
  - "coding":
    [
    {
    "system": "string",
    "code": "string",
    "display": "string"
    }
    ]
  }
],
"requirements": "string",
"copyright": "string",
"metadata":
{
- "capability":
  [
  - {
    "required": true,
    "description": "string",
    "destination": 0,
    "link":
    [
    { }
    ],
    "conformance":
    {
    "reference": "string"
    }
    }
  ]
},
"fixture":
[
- {
  - "id": "string",
  - "autocreate": true,
  - "autodelete": true,
  - "resource":
    {
    "reference": "string",
    "display": "string"
    }
  }
],
"profile":
[
- {
  - "id": "string",
  - "reference": "string"
  }
],
"setup":
{
- "action":
  [
  - {
    "fhir_comments":
    [
    { }
    ],
    "operation":
    {
    "type":
    {
    "code": "string"
    },
    "label": "string",
    "description": "string",
    "accept": "string",
    "responseId": "string",
    "sourceId": "string"
    }
    }
  ]
},
"test":
[
- {
  - "id": "string",
  - "name": "string",
  - "description": "string",
  - "action":
    [
    {
    "operation":
    {
    "type":
    {
    "code": "string"
    },
    "encodeRequestUrl": true,
    "responseId": "string",
    "targetId": "string"
    }
    }
    ]
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /TestScript/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/TestScript/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /TestScript/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/TestScript/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /TestScript/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/TestScript/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /TestScript/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/TestScript/{id}/_history/{vid}

ValueSet

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
meta required	object
text required	object
url required	string non-empty
_url required	object
identifier required	object
version required	string non-empty
_version required	object
name required	string non-empty
_name required	object
status required	string non-empty
experimental required	boolean
publisher required	string non-empty
contact required	Array of objects non-empty
date required	string non-empty
lockedDate required	string non-empty
_lockedDate required	object
description required	string non-empty
copyright required	string non-empty
compose required	object

Responses

200

Success

post /ValueSet

https://dev-pineapple-fhir.azurehealthcareapis.com/ValueSet

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"meta":
{
- "profile":
  [
  - { }
  ],
- "_profile":
  [
  - {
    "fhir_comments":
    [
    { }
    ]
    }
  ]
},
"text":
{
- "status": "string",
- "div": "string"
},
"url": "string",
"_url":
{
- "fhir_comments":
  [
  - { }
  ]
},
"identifier":
{
- "fhir_comments":
  [
  - { }
  ],
- "system": "string",
- "value": "string"
},
"version": "string",
"_version":
{
- "fhir_comments":
  [
  - { }
  ]
},
"name": "string",
"_name":
{
- "fhir_comments":
  [
  - { }
  ]
},
"status": "string",
"experimental": true,
"publisher": "string",
"contact":
[
- {
  - "name": "string",
  - "telecom":
    [
    {
    "system": "string",
    "value": "string"
    }
    ]
  }
],
"date": "string",
"lockedDate": "string",
"_lockedDate":
{
- "fhir_comments":
  [
  - { }
  ]
},
"description": "string",
"copyright": "string",
"compose":
{
- "include":
  [
  - {
    "fhir_comments":
    [
    { }
    ],
    "system": "string",
    "version": "string",
    "concept":
    [
    {
    "fhir_comments":
    [
    { }
    ],
    "code": "string",
    "display": "string",
    "_display":
    {
    "fhir_comments":
    [
    { }
    ]
    }
    }
    ]
    }
  ]
}

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
date	string <date> The value set publication date
description	string The description of the value set
expansion	string Uniquely identifies this expansion
identifier	string External identifier for the value set
jurisdiction	string Intended jurisdiction for the value set
name	string Computationally friendly name of the value set
publisher	string Name of the publisher of the value set
reference	string A code system included or excluded in the value set or an imported value set
status	string The current status of the value set
title	string The human-friendly name of the value set
url	string The uri that identifies the value set
version	string The business version of the value set
_format	string

Responses

200

Success

get /ValueSet

https://dev-pineapple-fhir.azurehealthcareapis.com/ValueSet

<no summary>

path Parameters

required

string

Responses

200

Success

get /ValueSet/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ValueSet/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
meta required	object
text required	object
url required	string non-empty
_url required	object
identifier required	object
version required	string non-empty
_version required	object
name required	string non-empty
_name required	object
status required	string non-empty
experimental required	boolean
publisher required	string non-empty
contact required	Array of objects non-empty
date required	string non-empty
lockedDate required	string non-empty
_lockedDate required	object
description required	string non-empty
copyright required	string non-empty
compose required	object

Responses

200

Success

put /ValueSet/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ValueSet/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"meta":
{
- "profile":
  [
  - { }
  ],
- "_profile":
  [
  - {
    "fhir_comments":
    [
    { }
    ]
    }
  ]
},
"text":
{
- "status": "string",
- "div": "string"
},
"url": "string",
"_url":
{
- "fhir_comments":
  [
  - { }
  ]
},
"identifier":
{
- "fhir_comments":
  [
  - { }
  ],
- "system": "string",
- "value": "string"
},
"version": "string",
"_version":
{
- "fhir_comments":
  [
  - { }
  ]
},
"name": "string",
"_name":
{
- "fhir_comments":
  [
  - { }
  ]
},
"status": "string",
"experimental": true,
"publisher": "string",
"contact":
[
- {
  - "name": "string",
  - "telecom":
    [
    {
    "system": "string",
    "value": "string"
    }
    ]
  }
],
"date": "string",
"lockedDate": "string",
"_lockedDate":
{
- "fhir_comments":
  [
  - { }
  ]
},
"description": "string",
"copyright": "string",
"compose":
{
- "include":
  [
  - {
    "fhir_comments":
    [
    { }
    ],
    "system": "string",
    "version": "string",
    "concept":
    [
    {
    "fhir_comments":
    [
    { }
    ],
    "code": "string",
    "display": "string",
    "_display":
    {
    "fhir_comments":
    [
    { }
    ]
    }
    }
    ]
    }
  ]
}

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /ValueSet/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/ValueSet/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /ValueSet/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ValueSet/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /ValueSet/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/ValueSet/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /ValueSet/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/ValueSet/{id}/_history/{vid}

VisionPrescription

<no summary>

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
dateWritten required	string non-empty
patient required	object
prescriber required	object
dispense required	Array of objects non-empty

Responses

200

Success

post /VisionPrescription

https://dev-pineapple-fhir.azurehealthcareapis.com/VisionPrescription

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"dateWritten": "string",
"patient":
{
- "reference": "string"
},
"prescriber":
{
- "reference": "string"
},
"dispense":
[
- {
  - "product":
    {
    "system": "string",
    "code": "string"
    },
  - "eye": "string",
  - "sphere": 0,
  - "cylinder": 0,
  - "axis": 0,
  - "prism": 0,
  - "base": "string",
  - "add": 0
  }
]

}

<no summary>

query Parameters

_id	string Logical id of this artifact
_lastUpdated	string <date> When the resource version last changed
_profile	string Profiles this resource claims to conform to
_security	string Security Labels applied to this resource
_tag	string Tags applied to this resource
datewritten	string <date> Return prescriptions written on this date
encounter	string Return prescriptions with this encounter identifier
identifier	string Return prescriptions with this external identifier
patient	string The identity of a patient to list dispenses for
prescriber	string Who authorizes the vision product
_format	string

Responses

200

Success

get /VisionPrescription

https://dev-pineapple-fhir.azurehealthcareapis.com/VisionPrescription

<no summary>

path Parameters

required

string

Responses

200

Success

get /VisionPrescription/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/VisionPrescription/{id}

<no summary>

path Parameters

required

string

Request Body schema: application/json

resourceType required	string non-empty
id required	string non-empty
text required	object
identifier required	Array of objects non-empty
dateWritten required	string non-empty
patient required	object
prescriber required	object
dispense required	Array of objects non-empty

Responses

200

Success

put /VisionPrescription/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/VisionPrescription/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"resourceType": "string",
"id": "string",
"text":
{
- "status": "string",
- "div": "string"
},
"identifier":
[
- {
  - "system": "string",
  - "value": "string"
  }
],
"dateWritten": "string",
"patient":
{
- "reference": "string"
},
"prescriber":
{
- "reference": "string"
},
"dispense":
[
- {
  - "product":
    {
    "system": "string",
    "code": "string"
    },
  - "eye": "string",
  - "sphere": 0,
  - "cylinder": 0,
  - "axis": 0,
  - "prism": 0,
  - "base": "string",
  - "add": 0
  }
]

}

<no summary>

path Parameters

required

string

Responses

200

Success

delete /VisionPrescription/{id}

https://dev-pineapple-fhir.azurehealthcareapis.com/VisionPrescription/{id}

<no summary>

path Parameters

required

string

query Parameters

_count	string
_since	string

Responses

200

Success

get /VisionPrescription/{id}/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/VisionPrescription/{id}/_history

<no summary>

query Parameters

_count	string
_since	string

Responses

200

Success

get /VisionPrescription/_history

https://dev-pineapple-fhir.azurehealthcareapis.com/VisionPrescription/_history

<no summary>

path Parameters

id required	string
vid required	string

Responses

200

Success

get /VisionPrescription/{id}/_history/{vid}

https://dev-pineapple-fhir.azurehealthcareapis.com/VisionPrescription/{id}/_history/{vid}